Skip to content
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

Zebra (LOCAL playbook for testing, DO NOT MERGE as it to docs-site) #659

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
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
79 changes: 79 additions & 0 deletions antora-playbook-zebra.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# 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-devex/docs-devex/
worktrees: true
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need this worktrees attribute for the live site, but understand for testing :)

branches: [release/7.2, capella-zebra, elixir]

- url: ../docs-server
branches: HEAD

- url: ../couchbase-cloud
branches: [HEAD]
start_paths: [ docs/public/capella, docs/public/elixir ]

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you want your name to be in this file? Just curious if this was intentional.

Copy link
Collaborator

Choose a reason for hiding this comment

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

If I've learnt anything from Banksy, it's that it's important to get your name and branding out there!

But, er, no, that's just a mistake, good catch 😹

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we still want kroki commented out?

Copy link
Collaborator

Choose a reason for hiding this comment

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

No, I was building locally on the day that Kroki was unhappy... lemme fix up this PR...

ui:
bundle:
# url: https://github.com/couchbase/docs-ui-sandbox/releases/download/prod-146/ui-bundle.zip
url: ../docs-ui/build/ui-bundle.zip
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm assuming we should also change where this points to for the UI bundle.

output:
dir: ./public