antora-playbook.yml

site:
  title: Docs
  # Special Instructions
  # In order to document the subtle configuration differences between
  # the main branch and the staging branch, this file should contain BOTH configurations.

  # In each section (e.g. Section 1), there should be one or more lines of code for the
  # main (Prod) branch, followed by corresponding lines of code for the staging branch.keys:

  # If this is the main (prod) branch, then comment out the staging branch config.
  # If this is the staging branch, then comment out the main branch config.

  # (1A) Purpose: Where will the site be published? For prod or preview?
  url: https://docs.tigergraph.com/ # For prod
  #url: https://docs-tigergraph.netlify.app/ # For Preview
  start_page: home::index.adoc

  # (1B) Purpose: Where is the sitemap, same as the site's URL (in 1A)?
  robots: | # For Prod (keep robots lines together as a block)
    User-agent: *
    Allow: /
    Sitemap: https://docs.tigergraph.com/sitemap.xml
  # Allow: /savanna/*
  #robots: | # For Preview (keep robots lines together as a block)
  #  User-agent: *
  #  Allow: /
  # Sitemap: https://docs-tigergraph.netlify.app/sitemap.xml

runtime:
  fetch: true
content:

  # (2) Purpose: Where is this file (antora-playbook.yml)?  Remote or local?
  # What branch, main or some staging, e.g. cloud-dev?
  sources:
    - url: https://github.com/tigergraph/doc-site.git
      branches: [main]
    #- url: https://github.com/tigergraph/doc-site.git
    #  branches: [staging]

      # (3) Purpose: What is the content: remote or local?
      # What versions (Previews will usually have extra versions).
      start_paths: home
    - url: https://github.com/tigergraph/cloud-docs.git
      branches: [main]
      start_paths: [modules/cloud, modules/savanna]
    - url: https://github.com/tigergraph/server-docs.git
      branches: [3.6, 3.9, "3.10", 3.11, 4.1]
    - url: https://github.com/tigergraph/gsql-docs.git
      branches: [3.6, 3.9, "3.10", 3.11, 4.1]
    - url: https://github.com/tigergraph/gui-docs.git
      branches: [3.6, 3.9, "3.10", 3.11, 4.1]
    - url: https://github.com/tigergraph/insights-docs
      branches: [3.6, 3.9, "3.10", 3.11, 4.1]
    - url: https://github.com/tigergraph/tigdsl-docs.git
      branches: ["3.10"]
    - url: https://github.com/tigergraph/tigergraphql.git
      branches: [3.9]
    - url: https://github.com/tigergraph/pytigergraph-docs
      branches: ["v1.6", "v1.7", "v1.8"]
    - url: https://github.com/tigergraph/mlworkbench-docs.git
      branches: [1.4]
    - url: https://github.com/tigergraph/copilot-docs.git
      branches: [main]
ui:
  bundle:
    url: https://github.com/tigergraph/antora-ui/blob/main/build/ui-bundle.zip?raw=true
    #url: /Users/victorlee/Documents/GitHub1/Docs/antora-ui/build/ui-bundle.zip?raw=true
    snapshot: true
asciidoc:
  attributes:
    page-component-order: '!home, tigergraph-server, gsql-ref, savanna, gui, insights, graph-ml, pytigergraph, ml-workbench, graphql, tg-copilot, cloud'
  extensions:
    - ./libs/tabs-block.js
urls:
  html_extension_style: drop
  latest_version_segment_strategy: redirect:from
  latest_version_segment: current
  redirect_facility: netlify