[docs] update deployment instructions

add instruction to build html files update .gitignore
dediha · Jul 13, 2023 · 6395145 · 6395145
1 parent 3ca8b6e
commit 6395145
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/docs/deploy-to-linux-docker.md b/docs/deploy-to-linux-docker.md
@@ -84,7 +84,7 @@ mkcert -install
 
 ### Setup .env file
 
-Edit `.env` file to match the `${SERVICE}_HOST` parameter to your the content of the `/etc/hosts` configuration.
+Edit `.env` file to match the `${SERVICE}_HOST` parameter to the content of the `/etc/hosts` configuration.
 
 Example with the domain `privacy-sandbox-demos-${SERVICE}.dev`
 
@@ -136,6 +136,20 @@ $ npm install
 $ npm run cert
 ```
 
+### Build html documentation
+
+Build the html static files that will be served by the home web server. The build process uses `docusaurus`.
+
+From the project root folder, **navigate to `services/home**` and run :
+
+```sh
+# Download package and dependencies (docusaurus)
+npm install
+
+# Build the html static files from the markdown docs.
+npm run build
+```
+
 ### Run start scripts
 
 ```sh

diff --git a/services/home/.gitignore b/services/home/.gitignore
@@ -1,10 +1,8 @@
 # Dependencies
 /node_modules
 
-# Production
-# /build
-# commit build for easy to deploy
-!/build
+# Production (do not commit build files)
+/build
 
 # Generated files
 .docusaurus