Deploying Documentation

Deployment Process

The documentation site is automatically built and deployed using Cloudflare Pages.

1. Source Repository: The source code for the documentation resides in the Phenom-earth/phenom-earth-docs GitHub repository.
2. Cloudflare Connection: Cloudflare Pages is linked directly to this GitHub repository.
3. Automatic Builds: When changes are pushed to the main branch on GitHub, Cloudflare Pages automatically triggers a new build process.
4. Build Command: Cloudflare uses Hugo (the static site generator) to build the site. The specific build command configured in Cloudflare Pages is likely hugo --gc --minify.
5. Deployment: Upon a successful build, Cloudflare Pages automatically deploys the updated static site to its global network.

This means that simply merging approved changes into the main branch is sufficient to update the live documentation site.

Access Control (GitHub OAuth)

Access to the deployed documentation site (potentially including preview deployments) is secured using GitHub OAuth.

1. Cloudflare Access Policy: An Access Policy is configured within Cloudflare Access for the documentation site’s URL.
2. GitHub Integration: This policy requires users to authenticate via GitHub.
3. Authorization: Only members belonging to the specified GitHub organization (Phenom-earth) are granted access after successful authentication.

This ensures that only authorized team members can view the documentation site.