Skip to content

DOC-13288 ia support #824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 127 additions & 0 deletions antora-playbook-DOC13288.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# 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
site:
title: Couchbase Docs
url: https://docs.couchbase.com
start_page: home::index.adoc
robots: |
User-agent: *
Allow: /
Disallow: /sdk-api/
Allow: /sdk-api/*-client/
Allow: /sdk-api/couchbase-core-io/
Allow: /sdk-api/couchbase-transactions-dotnet/
keys:
google_analytics: GTM-MVPNN2
nav_groups: |
[
{ "title": "Get Started", "startPage": "home::get-started.adoc", "components": ["server"] },
{
"title": "Develop",
"subGroups": [
{
"title": "Operational SDKs",
"startPage": "home::develop-operational.adoc",
"components": [
"java-sdk", "kotlin-sdk" ]
},
{
"title": "Analytic SDKs",
"startPage": "home::develop-analytics.adoc",
"components": ["*-columnar-sdk"]
},
{
"title": "Mobile SDKs",
"startPage": "home::develop-mobile.adoc",
"components": ["couchbase-lite"]
}
]
},
{ "title": "Deploy & Admin",
"subGroups": [
{
"title": "Mobile",
"startPage": "home::mobile-server-admin.adoc", "components": ["sync-gateway"]
}
]
},
{ "title": "Learn", "startPage": "home::learn-couchbase-concepts.adoc", "components": ["columnar"] }
]
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:
- url: .
branches: HEAD
start_path: home
- url: https://github.com/couchbase/docs-sdk-common
branches: [release/7.6]
- url: https://github.com/couchbase/docs-sdk-java
branches: [release/3.8]
- url: https://github.com/couchbase/docs-sdk-kotlin
branches: [temp/1.5]
- url: https://github.com/couchbase/docs-sdk-nodejs
branches: [temp/4.5]
- 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/couchbaselabs/docs-couchbase-lite
branches: [release/3.2]
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-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 columnar
sqlpp_url: https://www.couchbase.com/products/n1ql
cbpp: Couchbase++
kroki-server-url: http://3.91.133.254:9500
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/DOC-13288-ia-support-1/ui-bundle.zip
output:
dir: ./public
runtime:
fetch: true
2 changes: 2 additions & 0 deletions antora-playbook.preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ content:
branches: [release/1.0]
- url: https://github.com/couchbase/docs-sdk-dotnet
branches: [temp/3.6, release/3.5, release/3.4, release/3.3]
- url: https://github.com/couchbase/docs-columnar-sdk-go
branches: [release/1.0]
- url: https://github.com/couchbase/docs-sdk-go
branches: [temp/2.9, temp/2.8, release/2.7, release/2.6, release/2.5]
- url: https://github.com/couchbase/docs-sdk-java
Expand Down
1 change: 1 addition & 0 deletions home/modules/ROOT/pages/develop-analytics.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Develop - Analytics
1 change: 1 addition & 0 deletions home/modules/ROOT/pages/develop-mobile.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Develop - Mobile
1 change: 1 addition & 0 deletions home/modules/ROOT/pages/develop-operational.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Develop - Operational
51 changes: 51 additions & 0 deletions home/preview/DOC-13288-ia-support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
sources:
docs-sdk-c:
branches: [release/3.3]
docs-sdk-dotnet:
branches: [temp/3.7]
docs-columnar-sdk-go:
branches: [release/1.0]
docs-couchbase-lite:
branches: [release/3.2]

override:
ui:
bundle:
url: https://github.com/couchbase/docs-ui/releases/download/DOC-13288-ia-support-1/ui-bundle.zip

site:
keys:
navGroups: |
[
{ "title": "Get Started", "startPage": "home::get-started.adoc", "components": ["server"] },
{
"title": "Develop",
"subGroups": [
{
"title": "Operational SDKs",
"startPage": "home::develop-operational.adoc",
"components": [
"dotnet-sdk", "c-sdk" ]
},
{
"title": "Analytic SDKs",
"startPage": "home::develop-analytics.adoc",
"components": ["*-columnar-sdk"]
},
{
"title": "Mobile SDKs",
"startPage": "home::develop-mobile.adoc",
"components": ["couchbase-lite"]
}
]
},
{ "title": "Deploy & Admin",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this subGroups configuration is entirely new!

This change is backwards compatible:

  • older versions of the UI will ignore the subGroups
    (and the top-group UNLESS it has a URL)
  • the new version of the UI should accept items that don't have a subGroups clause.

"subGroups": [
{
"title": "Mobile",
"startPage": "home::mobile-server-admin.adoc", "components": ["sync-gateway"]
}
]
},
{ "title": "Learn", "startPage": "home::learn-couchbase-concepts.adoc", "components": ["columnar"] }
]
Loading