Appendix: Playbook Template

Appendix: antora-playbook.yml Template

Copy this into the hub repo root. This is the master config.

# ============================================================================
# Team Documentation — Antora Playbook
# ============================================================================
# This file orchestrates the entire documentation site.
#
# Usage:
#   npx antora antora-playbook.yml
#   make
#   make serve    (build + local preview on localhost:8080)
#
# Adding a new component:
#   1. Create the spoke repo with docs/antora.yml
#   2. Add a content source entry below
#   3. Rebuild
# ============================================================================

site:
  title: CHLA Network Engineering      # Site title in browser tab + header
  url: https://docs.example.com         # Production URL (or http://localhost:8080)
  start_page: home::index.adoc          # Default landing page

content:
  sources:
    # ────────────────────────────────────────────────────────────────
    # HUB (this repo) — landing pages and cross-cutting content
    # ────────────────────────────────────────────────────────────────
    - url: .
      branches: HEAD
      start_path: docs

    # ────────────────────────────────────────────────────────────────
    # SPOKE REPOS — one per documentation domain
    # ────────────────────────────────────────────────────────────────

    # Infrastructure Operations
    - url: https://github.com/your-org/infra-docs
      branches: main
      start_path: docs

    # NAC/ISE Operations
    # - url: https://github.com/your-org/nac-docs
    #   branches: main
    #   start_path: docs

    # Network Automation
    # - url: https://github.com/your-org/automation-docs
    #   branches: main
    #   start_path: docs

    # ────────────────────────────────────────────────────────────────
    # LOCAL DEVELOPMENT (uncomment for local dev, comment for CI)
    # ────────────────────────────────────────────────────────────────
    # - url: ../infra-docs
    #   branches: HEAD
    #   start_path: docs

ui:
  bundle:
    # Default Antora UI — works out of the box
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true
    # Custom UI (uncomment if using):
    # url: ./ui-bundle.zip
    # snapshot: true

asciidoc:
  attributes:
    # Suppress warnings for intentional placeholders
    attribute-missing: skip
    # Global attributes (available to ALL components)
    page-pagination: ""
    hide-uri-scheme: ""
    company-name: CHLA
    team-name: Network Engineering
  # Extensions (uncomment as needed):
  # extensions:
  #   - "@asciidoctor/tabs"
  #   - "asciidoctor-kroki"

output:
  dir: ./build/site
  clean: true

runtime:
  fetch: true
  cache_dir: .cache/antora