This repository hosts the documentation source for Couchbase Server.

Check out ourcontributing 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.

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’santora.yml file.

• The navigation for all Server modules, including those aggregated from other repositories, is stored in the ROOT module’snav.adoc file.

• Server documentation modules are also aggregated from theCouchbase CLI,Couchbase Enterprise Backup Client, andCouchbase Analytics repositories.

• Production branches use therelease/X.Y naming pattern (e.g., release/5.5, release/6.0).

  • Thedocs site playbook instructs Antora to automatically aggregate any branch names that start withrelease/.

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 andsite UI are orchestrated by thedocs site playbook.See the contributing guide to learn more.