Deploying Documentation

How the The Phenom App documentation site is deployed using Cloudflare Pages and secured with GitHub OAuth.

This page explains the automated deployment process for this documentation site via Cloudflare Pages and how access is managed.

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

Access to the deployed documentation site is secured using Cloudflare Access.

  1. Cloudflare Access Policy: An Access Policy is configured within Cloudflare Access for int-docs.thephenom.app.
  2. Identity Provider: The policy authenticates users via the phenom-dev-local Cognito user pool (us-east-1_AkG9mnbjA).
  3. Authorization: Only users with valid credentials in that pool are granted access.

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