11# npx antora --clean --fetch antora-playbook.yml
22# or
33# npx antora antora-playbook.yml
4+
45antora :
56 extensions :
67 - ' @antora/site-generator-ms'
78 - ./lib/embargo.js
89 - ./lib/antora-component-version-rank.js
10+
911site :
1012 title : Couchbase Docs
1113 url : https://docs.couchbase.com
14+
1215 start_page : home::index.adoc
16+
1317 robots : |
1418 User-agent: *
1519 Allow: /
1620 Disallow: /sdk-api/
1721 Allow: /sdk-api/*-client/
1822 Allow: /sdk-api/couchbase-core-io/
1923 Allow: /sdk-api/couchbase-transactions-dotnet/
24+
2025 keys :
2126 google_analytics : GTM-MVPNN2
27+
28+ # see https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/2963243023/FAQ+how+does+the+top+nav+bar+work
2229 nav_groups : |
2330 [
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"] },
31+ { "title": "Server", "startPage": "home::server.adoc", "components": ["server", "enterprise-analytics" ] },
32+ { "title": "Mobile / Edge ", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "sync-gateway", "couchbase-edge-server "] },
33+ { "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "analytics "] },
34+ { "title": "Cloud-Native", "components": ["cloud-native-database"] },
35+ { "title": "Kubernetes Operator", "startPage": "operator::overview.adoc ", "components": ["operator"] },
2936 { "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"] },
37+ { "title": "Develop", "startPage": "home::developer.adoc",
38+ "subGroups": [
39+ {
40+ "title": "Operational SDKs",
41+ "startPage": "home::sdk.adoc",
42+ "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"]
43+ },
44+ {
45+ "title": "Analytics SDKs",
46+ "startPage": "home::analytics-sdk.adoc",
47+ "components": ["*-analytics-sdk", "*-columnar-sdk"]
48+ }
49+ ]
50+ },
3251 { "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] },
3352 { "title": "Contribute", "components": ["home", "styleguide", "ui-ux", "pendo"] }
3453 ]
54+
3555git :
3656 ensure_git_suffix : false
3757 fetch_concurrency : 1
3858urls :
3959 latest_version_segment_strategy : redirect:to
4060 latest_version_segment : current
4161content :
62+
4263 branches : master
64+
4365 # NOTE the git@ segment in the URL indicates which repositories are private
4466 # # The above has a bug when upgrading to Antora 3.1. Original sources commented
4567 # # out and replaced with a non git@ prefix. To revert if it causes issues
68+
4669 sources :
70+
71+ # The main docs-site project
72+ # ###########################
73+
4774 - url : .
4875 branches : HEAD
4976 start_path : home
77+
5078 - url : https://github.com/couchbaselabs/docs-style-guide
5179 branches : main
5280 start_paths : [styleguide, ui-ux, pendo]
81+
82+ # Capella & related content
83+ # ###########################
84+
85+ # shared content for Server & Capella
5386 - url : https://github.com/couchbaselabs/docs-devex
54- branches : [release/7.6, release/7.2, capella]
87+ branches : [release/8.0, release/7.6, release/7.2, capella]
88+
5589 - url : https://github.com/couchbaselabs/cb-swagger
56- branches : [release/7.6, release/7.2, release/7.1, release/7.0, capella]
90+ branches : [release/8.0, release/ 7.6, release/7.2, release/7.1, release/7.0, capella]
5791 start_path : docs
5892 - url : https://github.com/couchbasecloud/couchbase-cloud
5993 branches : [main]
6094 start_paths : [docs/public, docs/columnar]
6195 - url : https://github.com/couchbase/docs-capella
6296 branches : [main]
97+
6398 - url : https://github.com/couchbaselabs/docs-columnar
64- branches : [main]
99+ branches :
100+ - main # `analytics` component (Capella Analytics)
101+ - legacy-columnar-component # `columnar` dummy component for sake of :page-aliases:
102+ # see under Server section below for enterprise-analytics and legacy analytics
103+
104+ # Couchbase Autonomous Kubernetes Operator
105+ # ###########################
106+
107+ # Generated content remains in monorepo
65108 - url : https://github.com/couchbase/couchbase-operator
66- branches : [2.7 .x]
109+ branches : [2.8.x, 2.7.x, 2.6.x, 2.5.x, 2.4 .x]
67110 start_path : docs/user
111+
112+ # handwritten content lives in docs-operator.
113+ - url : https://github.com/couchbase/docs-operator
114+ branches : [release/2.8, release/2.7, release/2.6, release/2.5, release/2.4]
115+
68116 - url : https://github.com/couchbaselabs/observability
69117 branches : [0.2.x]
70118 start_path : docs
71119 - url : https://github.com/couchbaselabs/cbmultimanager
72120 branches : [0.2.x]
73121 start_path : docs
122+ - url : https://github.com/couchbase/docs-cloud-native
123+ branches : [cloud-native-2.2]
124+
125+ # Connectors
126+ # ###########################
127+
74128 - url : https://github.com/couchbase/docs-elastic-search
75129 branches : [main]
76130 - url : https://github.com/couchbase/docs-kafka
77- branches : [main ]
131+ branches : [release/4.3, release/4.2 ]
78132 - url : https://github.com/couchbase/docs-spark
79- branches : [release/3.5]
133+ branches : [release/3.5, release/3.3 ]
80134 - url : https://github.com/couchbase/docs-tableau
81- branches : [release/1.1]
135+ branches : [release/1.1, release/1.0 ]
82136 - url : https://github.com/couchbase/docs-connectors-power-bi
83137 branches : [main]
84138 - url : https://github.com/couchbase/docs-connectors-superset.git
85139 branches : [release/1.0]
86140 - url : https://github.com/couchbase/docs-connectors-talend
141+
142+ # Server
143+ # ###########################
144+
145+ - url : https://github.com/couchbaselabs/docs-enterprise-analytics
146+ branches : [release/2.0]
87147 - url : https://github.com/couchbase/docs-analytics
88- branches : [release/7.6, release/7.2, release/7.1, release/7.0]
148+ branches : [release/8.0, release/7.6, release/7.2, release/7.1, release/7.0]
149+
89150 - url : https://github.com/couchbase/couchbase-cli
90- branches : [trinity, neo, 7.1.x-docs, cheshire-cat]
151+ branches : [morpheus, trinity, neo, 7.1.x-docs, cheshire-cat]
91152 start_path : docs
92153 - url : https://github.com/couchbase/backup
93- branches : [trinity, neo, 7.1.x-docs, cheshire-cat]
154+ branches : [morpheus, trinity, neo, 7.1.x-docs, cheshire-cat]
94155 start_path : docs
95- # NOTE docs-server is currently after other server repos so nav key wins
156+
157+ # NOTE docs-server is currently after other server repos so nav key wins
158+
96159 - url : https://github.com/couchbase/docs-server
97- branches : [release/7.6, release/7.2, release/7.1, release/7.0]
160+ branches : [release/8.0, release/7.6, release/7.2, release/7.1, release/7.0]
161+
162+ # SDK
163+ # ###########################
164+
98165 - url : https://github.com/couchbase/docs-sdk-common
99- branches : [release/7.6]
166+ branches : [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]
167+
100168 - url : https://github.com/couchbase/docs-sdk-c
101169 branches : [release/3.3]
102170 - url : https://github.com/couchbase/docs-sdk-cxx
103- branches : [release/1.0]
171+ branches : [release/1.2, release/1.1, release/1.0]
172+
173+ # .NET
104174 - url : https://github.com/couchbase/docs-sdk-dotnet
105- branches : [temp/3.6]
175+ branches : [temp/3.8, temp/3.7, temp/3.6, release/3.5]
176+ - url : https://github.com/couchbase/docs-efcore
177+ branches : [release/1.0]
178+
179+ # Go and Rust
106180 - url : https://github.com/couchbase/docs-sdk-go
107- branches : [temp/2.9]
181+ branches : [temp/2.11, temp/2.10, temp/2.9, temp/2.8, release/2.7]
182+ - url : https://github.com/couchbase/docs-sdk-rust
183+ branches : [release/1.0]
184+
185+ # JVM
108186 - url : https://github.com/couchbase/docs-sdk-java
109- branches : [temp/3.7]
187+ branches : [release/3.9, release/3.8, temp/3.7, temp/3.6, release/3.5 ]
110188 - url : https://github.com/couchbase/docs-quarkus-extension
111- branches : [release/1.0]
189+ branches : [release/1.1, release/1. 0]
112190 - url : https://github.com/couchbase/docs-sdk-kotlin
113- branches : [temp/1.4]
191+ branches : [temp/3.9, temp/1.5, temp/1.4, temp/1.3, release/1.2]
192+ - url : https://github.com/couchbase/docs-sdk-scala
193+ branches : [release/3.9, release/1.8, release/1.7, temp/1.6, release/1.5]
194+
195+ # "scripting languages"
114196 - url : https://github.com/couchbase/docs-sdk-nodejs
115- branches : [temp/4.4 ]
197+ branches : [temp/4.6, temp/4.5, temp/4.4, temp/4.3 ]
116198 - url : https://github.com/couchbase/docs-sdk-php
117- branches : [temp/4.2]
199+ branches : [temp/4.4, temp/4.3, temp/4. 2]
118200 - url : https://github.com/couchbase/docs-sdk-python
119- branches : [temp/4.3 ]
201+ branches : [temp/4.5, temp/4.4, temp/4.3, temp/4.2 ]
120202 - 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]
203+ branches : [temp/3.7, temp/3.6, temp/3.5]
204+
124205 - url : https://github.com/couchbase/docs-sdk-extensions
125206 branches : [main]
126- # Columnar dev
207+
208+ # Analytics SDKs (aka Columnar)
209+ # ###########################
210+
127211 - url : https://github.com/couchbase/docs-columnar-sdk-common
128212 branches : [release/1.0]
213+
214+ - url : https://github.com/couchbase/docs-columnar-sdk-go
215+ branches : [release/1.0]
129216 - url : https://github.com/couchbase/docs-columnar-sdk-java
130217 branches : [release/1.0]
131218 - url : https://github.com/couchbase/docs-columnar-sdk-nodejs
132219 branches : [release/1.0]
133220 - url : https://github.com/couchbase/docs-columnar-sdk-python
134221 branches : [release/1.0]
135- # Mobile Docs Pages
222+
223+ - url : https://github.com/couchbase/docs-analytics-sdk-common
224+ branches : [release/1.0]
225+
226+ - url : https://github.com/couchbase/docs-analytics-sdk-dotnet
227+ branches : [release/1.0]
228+ - url : https://github.com/couchbase/docs-analytics-sdk-go
229+ branches : [release/1.0]
230+ - url : https://github.com/couchbase/docs-analytics-sdk-java
231+ branches : [release/1.0]
232+ - url : https://github.com/couchbase/docs-analytics-sdk-nodejs
233+ branches : [release/1.0]
234+ - url : https://github.com/couchbase/docs-analytics-sdk-python
235+ branches : [release/1.0]
236+
237+ # Mobile
238+ # ###########################
239+
240+ # possibly legacy shared content
136241 - url : https://github.com/couchbase/docs-mobile
137- branches : [release/3.1]
242+ branches : [release/3.1, release/2.8]
243+
138244 - url : https://github.com/couchbaselabs/docs-couchbase-lite
139- branches : [release/3.2]
245+ branches : [release/3.3, release/3.2, release/3.1, release/3.0, release/2.8]
246+
140247 - 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]
248+ branches : [release/3.3, release/3.2, release/3.1, release/3.0, release/2.8]
249+
250+ - url : https://github.com/couchbaselabs/docs-couchbase-lite-edge-server
251+ branches : [release/1.0]
252+
253+ - url : https://github.com/couchbase/edge-server
254+ branches : [main]
255+ start_path : docs
256+
257+ # random mobile tutorials
144258 - url : https://github.com/couchbaselabs/mobile-travel-sample
145259 branches : [master]
146260 start_path : content
@@ -161,6 +275,7 @@ content:
161275 - url : https://github.com/couchbaselabs/couchbase-lite-peer-to-peer-sync-examples
162276 branches : [master]
163277 start_path : content
278+
164279asciidoc :
165280 attributes :
166281 site-navigation-data-path : _/js/site-navigation-data.js
@@ -173,17 +288,20 @@ asciidoc:
173288 tabs : tabs
174289 tabs-sync-option : ' '
175290 toc : ~
291+ page-chatbot-origin : https://d2sozpdiqok6m4.cloudfront.net # original Improving Canada bot
176292 page-toclevels : 1@
177293 page-rank : 50@
178294 xrefstyle : short
179295 enterprise : https://www.couchbase.com/products/editions[ENTERPRISE EDITION]
180296 community : https://www.couchbase.com/products/editions[COMMUNITY EDITION]
181297 sqlpp : SQL++
182- sqlppc : SQL++ for Capella columnar
298+ sqlppc : SQL++ for Capella Analytics
299+ sqlppea : SQL++ for Enterprise Analytics
183300 sqlpp_url : https://www.couchbase.com/products/n1ql
184301 cbpp : Couchbase++
185- kroki-server-url : http://3.91.133.254:9500
302+ kroki-server-url : ~
186303 kroki-fetch-diagram : true
304+
187305 extensions :
188306 - ./lib/source-url-include-processor.js
189307 - ./lib/json-config-ui-block-macro.js
@@ -195,9 +313,10 @@ asciidoc:
195313 - asciidoctor-kroki
196314 - asciidoctor-external-callout
197315 - ' @asciidoctor/tabs'
316+
198317ui :
199318 bundle :
200- url : https://github.com/couchbase/docs-ui/releases/download/prod-203 /ui-bundle.zip
319+ url : https://github.com/couchbase/docs-ui/releases/download/prod-218 /ui-bundle.zip
201320output :
202321 dir : ./public
203322runtime :
0 commit comments