From 7059d127bde20aa22e76f8f05084786f50ee6a78 Mon Sep 17 00:00:00 2001 From: Hakim Cassimally Date: Mon, 20 Feb 2023 16:50:54 +0000 Subject: [PATCH 1/3] zebra playbook (experiment) This playbook uses: - local docs-devex - main worktree in docs-devex/docs-devex - worktrees for: - capella-zebra (component `capella`) - elixir (component `elixir`) - local couchase-cloud (AV-52509-mockup-doc-striping-in-single-branch) with start_paths for: capella (component `capella`) elixir (component `elixir`) NB: nav includes Develop section - local docs-server with (release/7.2) --- antora-playbook-zebra.yml | 84 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 antora-playbook-zebra.yml diff --git a/antora-playbook-zebra.yml b/antora-playbook-zebra.yml new file mode 100644 index 0000000000..85fbd8fe4f --- /dev/null +++ b/antora-playbook-zebra.yml @@ -0,0 +1,84 @@ +# This playbook is copied and modified from the following source: +# https://github.com/couchbase/docs-site/blob/master/antora-playbook.yml +# This playbook needs to be run from a cloned version of https://github.com/couchbase/docs-site +antora: + extensions: + - '@antora/site-generator-ms' +site: + title: Couchbase Capella Staging Docs + url: https://docs.stage.nonprod-project-avengers.com + # This is the page ID for Couchbase Capella component start page. It replaces + # the regular Couchbase Docs homepage and takes the user right to the + # Couchbase Capella component. + start_page: cloud:ROOT:index.adoc + keys: + google_analytics: GTM-MVPNN2 + nav_groups: | + [ + { "title": "Server", "startPage": "home::server.adoc", "components": ["server"] }, + { "title": "Mobile", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "sync-gateway"] }, + { "title": "Capella", "startPage": "cloud::index.adoc", "components": ["cloud"] }, + { "title": "Cloud-Native", "startPage": "cloud-native-database::index.adoc", "components": ["cloud-native-database"] }, + { "title": "Autonomous Operator", "components": ["operator"] }, + { "title": "CMOS", "components": ["cmos"] }, + { "title": "Service Broker", "components": ["service-broker"] }, + { "title": "SDKs", "startPage": "home::sdk.adoc", "components": ["*-sdk", "cxx-txns", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector"] }, + { "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] } + ] +git: + ensure_git_suffix: false +content: + branches: master + # NOTE the git@ segment in the URL indicates which repositories are private + sources: + - url: . + branches: HEAD + start_path: home + #- url: ../docs-sync-gateway + #branches: HEAD + # - url: https://github.com/couchbaselabs/docs-devex + - url: ../docs-devex/docs-devex/ + worktrees: true + branches: [release/7.2, capella, elixir] + - url: ../docs-server + branches: HEAD + # - url: ../docs-couchbase-lite + # branches: HEAD + - url: ../couchbase-cloud + branches: [HEAD] + # start_path: docs/public + start_paths: [ docs/public/capella, docs/public/elixir ] + # - url: ../docs-devex/docs-devex + # worktrees: true + +asciidoc: + attributes: + azure-app-services: '' + sqlpp: SQL++ + max-include-depth: 10 + page-partial: false + experimental: '' + idprefix: '@' + idseparator: '-@' + tabs: tabs + toc: ~ + xrefstyle: short + enterprise: https://www.couchbase.com/products/editions[ENTERPRISE EDITION] + community: https://www.couchbase.com/products/editions[COMMUNITY EDITION] + site-navigation-data-path: _/js/site-navigation-data.js + local-build: HAKIM + 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/tabs-block.js + # - asciidoctor-kroki +ui: + bundle: + # url: https://github.com/couchbase/docs-ui-sandbox/releases/download/prod-146/ui-bundle.zip + url: ../docs-ui/build/ui-bundle.zip +output: + dir: ./public From 6a12901ce301b38dd6332c4b8028cbfcf7d47ba9 Mon Sep 17 00:00:00 2001 From: Hakim Cassimally Date: Mon, 20 Feb 2023 17:12:57 +0000 Subject: [PATCH 2/3] Update stripy zebra --- antora-playbook-zebra.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora-playbook-zebra.yml b/antora-playbook-zebra.yml index 85fbd8fe4f..f9c8030433 100644 --- a/antora-playbook-zebra.yml +++ b/antora-playbook-zebra.yml @@ -39,7 +39,7 @@ content: # - url: https://github.com/couchbaselabs/docs-devex - url: ../docs-devex/docs-devex/ worktrees: true - branches: [release/7.2, capella, elixir] + branches: [release/7.2, capella-zebra, elixir] - url: ../docs-server branches: HEAD # - url: ../docs-couchbase-lite From 0fa1376971bd5709b3fbe3a3bc83b042b561b4c2 Mon Sep 17 00:00:00 2001 From: Hakim Cassimally Date: Tue, 21 Feb 2023 08:45:39 +0000 Subject: [PATCH 3/3] zebra tidy --- antora-playbook-zebra.yml | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/antora-playbook-zebra.yml b/antora-playbook-zebra.yml index f9c8030433..1f39dc4985 100644 --- a/antora-playbook-zebra.yml +++ b/antora-playbook-zebra.yml @@ -34,22 +34,17 @@ content: - url: . branches: HEAD start_path: home - #- url: ../docs-sync-gateway - #branches: HEAD - # - url: https://github.com/couchbaselabs/docs-devex + - url: ../docs-devex/docs-devex/ worktrees: true branches: [release/7.2, capella-zebra, elixir] + - url: ../docs-server branches: HEAD - # - url: ../docs-couchbase-lite - # branches: HEAD + - url: ../couchbase-cloud branches: [HEAD] - # start_path: docs/public start_paths: [ docs/public/capella, docs/public/elixir ] - # - url: ../docs-devex/docs-devex - # worktrees: true asciidoc: attributes: