|
| 1 | +# npx antora --clean --fetch antora-playbook.yml |
| 2 | +# or |
| 3 | +# npx antora antora-playbook.yml |
| 4 | +antora: |
| 5 | + extensions: |
| 6 | + - '@antora/site-generator-ms' |
| 7 | + - ./lib/embargo.js |
| 8 | + - ./lib/antora-component-version-rank.js |
| 9 | +site: |
| 10 | + title: Couchbase Docs |
| 11 | + url: https://docs.couchbase.com |
| 12 | + start_page: home::index.adoc |
| 13 | + robots: | |
| 14 | + User-agent: * |
| 15 | + Allow: / |
| 16 | + Disallow: /sdk-api/ |
| 17 | + Allow: /sdk-api/*-client/ |
| 18 | + Allow: /sdk-api/couchbase-core-io/ |
| 19 | + Allow: /sdk-api/couchbase-transactions-dotnet/ |
| 20 | + keys: |
| 21 | + google_analytics: GTM-MVPNN2 |
| 22 | + nav_groups: | |
| 23 | + [ |
| 24 | + { "title": "Server", "startPage": "home::server.adoc", "components": ["server"] }, |
| 25 | + { "title": "Mobile", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "sync-gateway"] }, |
| 26 | + { "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "columnar"] }, |
| 27 | + { "title": "Cloud-Native", "startPage": "cloud-native-database::index.adoc", "components": ["cloud-native-database"] }, |
| 28 | + { "title": "Autonomous Operator", "components": ["operator"] }, |
| 29 | + { "title": "CMOS", "components": ["cmos"] }, |
| 30 | + { "title": "Couchbase SDKs", "startPage": "home::sdk.adoc", "components": ["dotnet-sdk", "c-sdk", "cxx-sdk", "go-sdk", "java-sdk", "quarkus-extension", "kotlin-sdk", "nodejs-sdk", "php-sdk", "python-sdk", "ruby-sdk", "scala-sdk", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "superset-connector", "sdk-extensions"] }, |
| 31 | + { "title": "Columnar SDKs", "startPage": "home::columnar-sdk.adoc", "components": ["*-columnar-sdk"] }, |
| 32 | + { "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] }, |
| 33 | + { "title": "Contribute", "components": ["home", "styleguide", "ui-ux", "pendo"] } |
| 34 | + ] |
| 35 | +git: |
| 36 | + ensure_git_suffix: false |
| 37 | + fetch_concurrency: 1 |
| 38 | +urls: |
| 39 | + latest_version_segment_strategy: redirect:to |
| 40 | + latest_version_segment: current |
| 41 | +content: |
| 42 | + branches: master |
| 43 | + # NOTE the git@ segment in the URL indicates which repositories are private |
| 44 | + ## The above has a bug when upgrading to Antora 3.1. Original sources commented |
| 45 | + ## out and replaced with a non git@ prefix. To revert if it causes issues |
| 46 | + sources: |
| 47 | + - url: . |
| 48 | + branches: HEAD |
| 49 | + start_path: home |
| 50 | + - url: https://github.com/couchbaselabs/docs-style-guide |
| 51 | + branches: main |
| 52 | + start_paths: [styleguide, ui-ux, pendo] |
| 53 | + - url: https://github.com/couchbaselabs/docs-devex |
| 54 | + branches: [release/7.6, capella] |
| 55 | + - url: https://github.com/couchbaselabs/cb-swagger |
| 56 | + branches: [release/7.6, capella] |
| 57 | + start_path: docs |
| 58 | + - url: https://github.com/couchbasecloud/couchbase-cloud |
| 59 | + branches: [main] |
| 60 | + start_paths: [docs/public, docs/columnar] |
| 61 | + - url: https://github.com/couchbase/docs-capella |
| 62 | + branches: [main] |
| 63 | + - url: https://github.com/couchbaselabs/docs-columnar |
| 64 | + branches: [main] |
| 65 | + - url: https://github.com/couchbase/couchbase-operator |
| 66 | + branches: [2.7.x] |
| 67 | + start_path: docs/user |
| 68 | + - url: https://github.com/couchbaselabs/observability |
| 69 | + branches: [0.2.x] |
| 70 | + start_path: docs |
| 71 | + - url: https://github.com/couchbaselabs/cbmultimanager |
| 72 | + branches: [0.2.x] |
| 73 | + start_path: docs |
| 74 | + - url: https://github.com/couchbase/docs-elastic-search |
| 75 | + branches: [main] |
| 76 | + - url: https://github.com/couchbase/docs-kafka |
| 77 | + branches: [main] |
| 78 | + - url: https://github.com/couchbase/docs-spark |
| 79 | + branches: [release/3.5] |
| 80 | + - url: https://github.com/couchbase/docs-tableau |
| 81 | + branches: [release/1.1] |
| 82 | + - url: https://github.com/couchbase/docs-connectors-power-bi |
| 83 | + branches: [main] |
| 84 | + - url: https://github.com/couchbase/docs-connectors-superset.git |
| 85 | + branches: [release/1.0] |
| 86 | + - url: https://github.com/couchbase/docs-connectors-talend |
| 87 | + - url: https://github.com/couchbase/docs-analytics |
| 88 | + branches: [release/7.6] |
| 89 | + - url: https://github.com/couchbase/couchbase-cli |
| 90 | + branches: [trinity] |
| 91 | + start_path: docs |
| 92 | + - url: https://github.com/couchbase/backup |
| 93 | + branches: [trinity] |
| 94 | + start_path: docs |
| 95 | + # NOTE docs-server is currently after other server repos so nav key wins |
| 96 | + - url: https://github.com/couchbase/docs-server |
| 97 | + branches: [release/7.6] |
| 98 | + - url: https://github.com/couchbase/docs-sdk-common |
| 99 | + branches: [release/7.6] |
| 100 | + - url: https://github.com/couchbase/docs-sdk-c |
| 101 | + branches: [release/3.3] |
| 102 | + - url: https://github.com/couchbase/docs-sdk-cxx |
| 103 | + branches: [release/1.0] |
| 104 | + - url: https://github.com/couchbase/docs-sdk-dotnet |
| 105 | + branches: [temp/3.6] |
| 106 | + - url: https://github.com/couchbase/docs-sdk-go |
| 107 | + branches: [temp/2.9] |
| 108 | + - url: https://github.com/couchbase/docs-sdk-java |
| 109 | + branches: [temp/3.7] |
| 110 | + - url: https://github.com/couchbase/docs-quarkus-extension |
| 111 | + branches: [release/1.0] |
| 112 | + - url: https://github.com/couchbase/docs-sdk-kotlin |
| 113 | + branches: [temp/1.4] |
| 114 | + - url: https://github.com/couchbase/docs-sdk-nodejs |
| 115 | + branches: [temp/4.4] |
| 116 | + - url: https://github.com/couchbase/docs-sdk-php |
| 117 | + branches: [temp/4.2] |
| 118 | + - url: https://github.com/couchbase/docs-sdk-python |
| 119 | + branches: [temp/4.3] |
| 120 | + - url: https://github.com/couchbase/docs-sdk-ruby |
| 121 | + branches: [temp/3.5] |
| 122 | + - url: https://github.com/couchbase/docs-sdk-scala |
| 123 | + branches: [release/1.7] |
| 124 | + - url: https://github.com/couchbase/docs-sdk-extensions |
| 125 | + branches: [main] |
| 126 | + # Columnar dev |
| 127 | + - url: https://github.com/couchbase/docs-columnar-sdk-common |
| 128 | + branches: [release/1.0] |
| 129 | + - url: https://github.com/couchbase/docs-columnar-sdk-java |
| 130 | + branches: [release/1.0] |
| 131 | + - url: https://github.com/couchbase/docs-columnar-sdk-nodejs |
| 132 | + branches: [release/1.0] |
| 133 | + - url: https://github.com/couchbase/docs-columnar-sdk-python |
| 134 | + branches: [release/1.0] |
| 135 | + # Mobile Docs Pages |
| 136 | + - url: https://github.com/couchbase/docs-mobile |
| 137 | + branches: [release/3.1] |
| 138 | + - url: https://github.com/couchbaselabs/docs-couchbase-lite |
| 139 | + branches: [release/3.2] |
| 140 | + - url: https://github.com/couchbaselabs/docs-sync-gateway |
| 141 | + branches: [release/3.2] |
| 142 | + - url: https://github.com/couchbase/docs-cloud-native |
| 143 | + branches: [cloud-native-2.2] |
| 144 | + - url: https://github.com/couchbaselabs/mobile-travel-sample |
| 145 | + branches: [master] |
| 146 | + start_path: content |
| 147 | + - url: https://github.com/couchbaselabs/mobile-training-todo |
| 148 | + branches: tutorials |
| 149 | + start_path: content |
| 150 | + - url: https://github.com/couchbaselabs/UniversityLister-Android |
| 151 | + start_path: content |
| 152 | + - url: https://github.com/couchbaselabs/userprofile-couchbase-mobile |
| 153 | + branches: [standalone, query, sync, backgroundfetch] |
| 154 | + start_path: content |
| 155 | + - url: https://github.com/couchbaselabs/userprofile-couchbase-mobile-xamarin |
| 156 | + branches: [standalone, query, sync] |
| 157 | + start_path: content |
| 158 | + - url: https://github.com/couchbaselabs/userprofile-couchbase-mobile-android |
| 159 | + branches: [standalone, query, sync] |
| 160 | + start_path: content |
| 161 | + - url: https://github.com/couchbaselabs/couchbase-lite-peer-to-peer-sync-examples |
| 162 | + branches: [master] |
| 163 | + start_path: content |
| 164 | +asciidoc: |
| 165 | + attributes: |
| 166 | + site-navigation-data-path: _/js/site-navigation-data.js |
| 167 | + enable-cmos: '' |
| 168 | + max-include-depth: 10 |
| 169 | + page-partial: false |
| 170 | + experimental: '' |
| 171 | + idprefix: '@' |
| 172 | + idseparator: '-@' |
| 173 | + tabs: tabs |
| 174 | + tabs-sync-option: '' |
| 175 | + toc: ~ |
| 176 | + page-toclevels: 1@ |
| 177 | + page-rank: 50@ |
| 178 | + xrefstyle: short |
| 179 | + enterprise: https://www.couchbase.com/products/editions[ENTERPRISE EDITION] |
| 180 | + community: https://www.couchbase.com/products/editions[COMMUNITY EDITION] |
| 181 | + sqlpp: SQL++ |
| 182 | + sqlppc: SQL++ for Capella columnar |
| 183 | + sqlpp_url: https://www.couchbase.com/products/n1ql |
| 184 | + cbpp: Couchbase++ |
| 185 | + kroki-server-url: http://3.91.133.254:9500 |
| 186 | + kroki-fetch-diagram: true |
| 187 | + extensions: |
| 188 | + - ./lib/source-url-include-processor.js |
| 189 | + - ./lib/json-config-ui-block-macro.js |
| 190 | + - ./lib/inline-man-macro.js |
| 191 | + - ./lib/multirow-table-head-tree-processor.js |
| 192 | + - ./lib/swagger-ui-block-macro.js |
| 193 | + - ./lib/markdown-block.js |
| 194 | + - ./lib/template-block.js |
| 195 | + - asciidoctor-kroki |
| 196 | + - asciidoctor-external-callout |
| 197 | + - '@asciidoctor/tabs' |
| 198 | +ui: |
| 199 | + bundle: |
| 200 | + url: https://github.com/couchbase/docs-ui/releases/download/prod-203/ui-bundle.zip |
| 201 | +output: |
| 202 | + dir: ./public |
| 203 | +runtime: |
| 204 | + fetch: true |
0 commit comments