Couchbase Server Documentation
This repository hosts the documentation source for Couchbase Server.
Contributing
Check out our contributing guide to learn how to:
-
submit a bug or feedback issue
-
set up your documentation workspace
-
build the documentation
-
submit a pull request
Thank you for helping to make the documentation better.
Docs Component Configuration
This repository contains an Antora docs component. Keep in mind these key repository features:
-
Component name, version, and start page are configured in each branch’s antora.yml file.
-
The navigation for all Server modules, including those aggregated from other repositories, is stored in the ROOT module’s nav.adoc file.
-
Server documentation modules are also aggregated from the Couchbase CLI, Couchbase Enterprise Backup Client, and Couchbase Analytics repositories.
-
Production branches use the release/X.Y naming pattern (e.g., release/5.5, release/6.0).
-
The docs site playbook instructs Antora to automatically aggregate any branch names that start with release/.
-
Documentation Site Toolchain
The documentation source files are marked up with AsciiDoc. Once merged into a version branch, the source files and their assets are aggregated, converted to HTML, and published by Antora to our staging and production sites. The docs components and site UI are orchestrated by the docs site playbook. See the contributing guide to learn more.