Skip to content

Adding Sites

Add a new documentation site by extending the sites variable.

Steps

The sites variable is the authoritative build definition. The hub build script reads it directly.

  1. Add an entry to sites in variables.tf default or override in terraform.tfvars:
sites = {
  # existing sites ...
  new-repo = {
    display_name = "New Repo"
    description  = "Description of the new repository docs"
    repo_name    = "new-repo"
  }
}

  1. Add a link to hub/docs/index.md pointing to /<new-repo>/.

  2. Plan and apply:

just plan
just apply
  1. Deploy:
just deploy-all

What Gets Created

For each new entry, the consolidated build adds:

  • A subdirectory at docs.example.com/<key>/ served from the hub Pages project
  • A link on the hub landing page
  • The hub's Access application covers the new path automatically