docs: deploy generated docs to a different folder, add github setup i…

…nstructions
orefalo · Jun 18, 2024 · 3660a85 · 3660a85
1 parent aa20914
commit 3660a85
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.github/workflows/deploy-ghpages.yml b/.github/workflows/deploy-ghpages.yml
@@ -69,4 +69,4 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: docs
-          target-folder: docs
+          target-folder: generated-docs
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -250,3 +250,18 @@ END_COMMIT_OVERRIDE
 ```
 
 Source: https://github.com/googleapis/release-please#how-can-i-fix-release-notes
+
+## GitHub Configured
+
+### Code and Automation / Actions / General
+
+- Workflow must have `R/W` permissions
+- Check `Allow GitHub Actions to create and approve pull requests`
+
+### Code and Automation / GH Pages
+
+- Point it to branch `gh-pages`, folder `generated-docs`
+
+### Security / Secrets and variables / Actions / Respository secrets
+
+- Define secret `NPM_TOKEN` with a finegrained RW access token from NPM, for security is should be restricted to repository.