antora-playbook.yml

# npx antora --clean --fetch antora-playbook.yml
# or
# npx antora antora-playbook.yml

antora:
  extensions:
  - '@antora/site-generator-ms'
  - ./lib/embargo.js
  - ./lib/antora-component-version-rank.js
  - ./lib/llms-txt.js

site:
  title: Couchbase Docs
  url: https://docs.couchbase.com

  start_page: home::index.adoc

  robots: |
    # AI Crawlers — guided entry
    User-agent: ClaudeBot
    User-agent: GPTBot
    User-agent: PerplexityBot
    User-agent: Google-Extended
    Allow: /
    Allow: /*.md$
    Disallow: /sdk-api/
    Allow: /sdk-api/*-client/
    Allow: /sdk-api/couchbase-core-io/
    Allow: /sdk-api/couchbase-transactions-dotnet/
    # Sitemap and LLM index
    Sitemap: https://docs.couchbase.com/sitemap.xml
    # Access
    User-agent: *
    Allow: /
    Disallow: /*.md$
    Disallow: /sdk-api/
    Allow: /sdk-api/*-client/
    Allow: /sdk-api/couchbase-core-io/
    Allow: /sdk-api/couchbase-transactions-dotnet/
    # Sitemap and LLM index
    Sitemap: https://docs.couchbase.com/sitemap.xml

  keys:
    google_analytics: GTM-MVPNN2

    # see https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/2963243023/FAQ+how+does+the+top+nav+bar+work
    nav_groups: |
      [
        { "title": "Server", "startPage": "home::server.adoc", "components": ["server", "enterprise-analytics"] },
        { "title": "Mobile / Edge", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "couchbase-lite-javascript", "sync-gateway", "couchbase-edge-server"] },
        { "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "app-services", "ai", "analytics"] },
        { "title": "Kubernetes Operator", "startPage": "operator::overview.adoc", "components": ["operator"] },
        { "title": "CMOS", "components": ["cmos"] },
        { "title": "Develop", "startPage": "home::developer.adoc",
            "subGroups": [
              {
                "title": "Operational SDKs",
                "startPage": "home::sdk.adoc",
                "components": ["develop", "dotnet-sdk", "efcore-provider", "c-sdk", "cxx-sdk", "go-sdk", "java-sdk", "quarkus-extension", "kotlin-sdk", "nodejs-sdk", "php-sdk", "python-sdk", "ruby-sdk", "rust-sdk", "scala-sdk", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "superset-connector", "sdk-extensions"]
              },
              {
                "title": "Analytics SDKs",
                "startPage": "home::analytics-sdk.adoc",
                "components": ["*-analytics-sdk", "*-columnar-sdk"]
              }
            ]
          },
        { "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] },
        { "title": "Contribute", "components": ["home", "styleguide", "ui-ux", "pendo"] }
      ]

git:
  ensure_git_suffix: false
  fetch_concurrency: 1
urls:
  latest_version_segment_strategy: redirect:to
  latest_version_segment: current
content:

  branches: master

  # NOTE the git@ segment in the URL indicates which repositories are private
  ## The above has a bug when upgrading to Antora 3.1. Original sources commented
  ## out and replaced with a non git@ prefix. To revert if it causes issues

  sources:

    # The main docs-site project
    ############################

  - url: .
    branches: HEAD
    start_path: home

  - url: https://github.com/couchbaselabs/docs-style-guide
    branches: main
    start_paths: [styleguide, ui-ux, pendo]

    # Capella & related content
    ############################

    # shared content for Server & Capella
  - url: https://github.com/couchbaselabs/docs-devex
    branches: [release/8.0, release/7.6, release/7.2, capella]

  - url: https://github.com/couchbaselabs/cb-swagger
    branches: [release/8.0, release/7.6, release/7.2, capella]
    start_path: docs
  - url: https://github.com/couchbasecloud/couchbase-cloud
    branches: [main]
    start_paths: [docs/public, docs/columnar]
  - url: https://github.com/couchbase/docs-capella
    branches: [main]

  - url: https://github.com/couchbaselabs/docs-capella-app-services
    branches: [main]

  - url: https://github.com/couchbaselabs/docs-columnar
    branches:
      - main                      # `analytics` component (Capella Analytics)
      - legacy-columnar-component # `columnar` dummy component for sake of :page-aliases:
    # see under Server section below for enterprise-analytics and legacy analytics

  - url: https://github.com/couchbaselabs/docs-ai
    branches: [main]

    # Couchbase Autonomous Kubernetes Operator
    ############################

    # Generated content remains in monorepo
  - url: https://github.com/couchbase/couchbase-operator
    branches: [2.9.x, 2.8.x, 2.7.x, 2.6.x, 2.5.x]
    start_path: docs/user

    # handwritten content lives in docs-operator.
  - url: https://github.com/couchbase/docs-operator
    branches: [release/2.9, release/2.8, release/2.7, release/2.6, release/2.5]

  - url: https://github.com/couchbaselabs/observability
    branches: [0.2.x]
    start_path: docs
  - url: https://github.com/couchbaselabs/cbmultimanager
    branches: [0.2.x]
    start_path: docs

    # Connectors
    ############################

  - url: https://github.com/couchbase/docs-elastic-search
    branches: [main]
  - url: https://github.com/couchbase/docs-kafka
    branches: [release/4.3, release/4.2]
  - url: https://github.com/couchbase/docs-spark
    branches: [release/3.5, release/3.3]
  - url: https://github.com/couchbase/docs-tableau
    branches: [release/1.1, release/1.0]
  - url: https://github.com/couchbase/docs-connectors-power-bi
    branches: [release/1.2, release/1.1, release/1.0]
  - url: https://github.com/couchbase/docs-connectors-superset.git
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-connectors-talend

    # Server
    ############################

  - url: https://github.com/couchbaselabs/docs-enterprise-analytics
    branches: [release/2.1, release/2.0]
  - url: https://github.com/couchbase/docs-analytics
    branches: [release/8.0, release/7.6, release/7.2]

  - url: https://github.com/couchbase/couchbase-cli
    branches: [morpheus, trinity, neo]
    start_path: docs
  - url: https://github.com/couchbase/backup
    branches: [morpheus, trinity, neo]
    start_path: docs

    # NOTE docs-server is currently after other server repos so nav key wins

  - url: https://github.com/couchbase/docs-server
    branches: [release/8.0, release/7.6, release/7.2]

    # SDK
    ############################

  - url: https://github.com/couchbase/docs-sdk-common
    branches: [release/8.0.1, release/8.0, release/7.7, release/7.6.6, release/7.6.2, release/7.6, temp/7.5, release/7.2, release/7.1.2, release/7.1, release/7.0, release/6.6, release/6.5]

  - url: https://github.com/couchbase/docs-sdk-c
    branches: [release/3.3]
  - url: https://github.com/couchbase/docs-sdk-cxx
    branches: [release/1.3, release/1.2, release/1.1, release/1.0]

    # .NET
  - url: https://github.com/couchbase/docs-sdk-dotnet
    branches: [temp/3.9, temp/3.8, temp/3.7, temp/3.6, release/3.5]
  - url: https://github.com/couchbase/docs-efcore
    branches: [release/1.0]

    # Go and Rust
  - url: https://github.com/couchbase/docs-sdk-go
    branches: [release/2.12, temp/2.11, temp/2.10, temp/2.9, temp/2.8, release/2.7]
  - url: https://github.com/couchbase/docs-sdk-rust
    branches: [release/1.0]

    # JVM
  - url: https://github.com/couchbase/docs-sdk-java
    branches: [release/3.11, release/3.10, release/3.9, release/3.8, temp/3.7, temp/3.6, release/3.5]
  - url: https://github.com/couchbase/docs-quarkus-extension
    branches: [release/1.3, release/1.2, release/1.1, release/1.0]
  - url: https://github.com/couchbase/docs-sdk-kotlin
    branches: [temp/3.11, temp/3.10, temp/3.9, temp/1.5, temp/1.4, temp/1.3, release/1.2]
  - url: https://github.com/couchbase/docs-sdk-scala
    branches: [release/3.11, release/3.10, release/3.9, release/1.8, release/1.7, temp/1.6, release/1.5]

    # "scripting languages"
  - url: https://github.com/couchbase/docs-sdk-nodejs
    branches: [temp/4.7, temp/4.6, temp/4.5, temp/4.4, temp/4.3]
  - url: https://github.com/couchbase/docs-sdk-php
    branches: [temp/4.5, temp/4.4, temp/4.3, temp/4.2]
  - url: https://github.com/couchbase/docs-sdk-python
    branches: [release/4.6, temp/4.5, temp/4.4, temp/4.3, temp/4.2]
  - url: https://github.com/couchbase/docs-sdk-ruby
    branches: [temp/3.8, temp/3.7, temp/3.6, temp/3.5]

  - url: https://github.com/couchbase/docs-sdk-extensions
    branches: [main]

    # Analytics SDKs (aka Columnar)
    ############################

  - url: https://github.com/couchbase/docs-columnar-sdk-common
    branches: [release/1.0]

  - url: https://github.com/couchbase/docs-columnar-sdk-go
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-columnar-sdk-java
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-columnar-sdk-nodejs
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-columnar-sdk-python
    branches: [release/1.0]

  - url: https://github.com/couchbase/docs-analytics-sdk-common
    branches: [release/1.0]

  - url: https://github.com/couchbase/docs-analytics-sdk-dotnet
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-analytics-sdk-go
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-analytics-sdk-java
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-analytics-sdk-nodejs
    branches: [release/1.0]
  - url: https://github.com/couchbase/docs-analytics-sdk-python
    branches: [release/1.0]

    # Mobile
    ############################

    # possibly legacy shared content
  - url: https://github.com/couchbase/docs-mobile
    branches: [release/3.1, release/2.8]

  - url: https://github.com/couchbase/docs-couchbase-lite
    branches: [release/4.0, release/3.3, release/3.2, release/3.1, release/3.0, release/2.8]

  - url: https://github.com/couchbaselabs/docs-couchbase-lite-js
    branches: [release/1.0]

  - url: https://github.com/couchbase/docs-sync-gateway
    branches: [release/4.0, release/3.3, release/3.2, release/3.1, release/3.0, release/2.8]

  - url: https://github.com/couchbaselabs/docs-couchbase-lite-edge-server
    branches: [release/1.0]

  - url: https://github.com/couchbase/edge-server
    branches: [main]
    start_path: docs

    # random mobile tutorials
  - url: https://github.com/couchbaselabs/mobile-travel-sample
    branches: [master]
    start_path: content
  - url: https://github.com/couchbaselabs/mobile-training-todo
    branches: tutorials
    start_path: content
  - url: https://github.com/couchbaselabs/UniversityLister-Android
    start_path: content
  - url: https://github.com/couchbaselabs/userprofile-couchbase-mobile
    branches: [standalone, query, sync, backgroundfetch]
    start_path: content
  - url: https://github.com/couchbaselabs/userprofile-couchbase-mobile-xamarin
    branches: [standalone, query, sync]
    start_path: content
  - url: https://github.com/couchbaselabs/userprofile-couchbase-mobile-android
    branches: [standalone, query, sync]
    start_path: content
  - url: https://github.com/couchbaselabs/couchbase-lite-peer-to-peer-sync-examples
    branches: [master]
    start_path: content

asciidoc:
  attributes:
    site-navigation-data-path: _/js/site-navigation-data.js
    enable-cmos: ''
    max-include-depth: 10
    page-partial: false
    experimental: ''
    idprefix: '@'
    idseparator: '-@'
    tabs: tabs
    tabs-sync-option: ''
    toc: ~
    page-chatbot-origin: https://d2sozpdiqok6m4.cloudfront.net # original Improving Canada bot
    page-toclevels: 1@
    page-rank: 50@
    xrefstyle: short
    enterprise: https://www.couchbase.com/products/editions[ENTERPRISE EDITION]
    community: https://www.couchbase.com/products/editions[COMMUNITY EDITION]
    sqlpp: SQL++
    sqlppc: SQL++ for Capella Analytics
    sqlppea: SQL++ for Enterprise Analytics
    sqlpp_url: https://www.couchbase.com/products/n1ql
    cbpp: Couchbase++
    kroki-server-url: ~
    kroki-fetch-diagram: true

  extensions:
  - ./lib/source-url-include-processor.js
  - ./lib/json-config-ui-block-macro.js
  - ./lib/inline-man-macro.js
  - ./lib/multirow-table-head-tree-processor.js
  - ./lib/swagger-ui-block-macro.js
  - ./lib/markdown-block.js
  - ./lib/template-block.js
  - asciidoctor-kroki
  - asciidoctor-external-callout
  - '@asciidoctor/tabs'

ui:
  bundle:
    url: https://github.com/couchbase/docs-ui/releases/download/prod-227/ui-bundle.zip
output:
  dir: ./public
runtime:
  fetch: true