docs-server

docs-server copied to clipboard

= Couchbase Server Documentation // Settings: ifdef::env-github[] :warning-caption: :warning: endif::[] // URLs: :url-org: https://github.com/couchbase :url-contribute: https://docs.couchbase.com/home/contribute/index.html :url-ui: {url-org}/docs-ui :url-playbook: {url-org}/docs-site :url-cli: {url-org}/couchbase-cli :url-backup: {url-org}/backup :url-analytics: https://github.com/couchbaselabs/asterix-opt :url-license: https://creativecommons.org/licenses/by-nc-sa/4.0/

This repository hosts the documentation source for Couchbase Server.

== Contributing

Check out our {url-contribute}[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 {url-cli}[Couchbase CLI], {url-backup}[Couchbase Enterprise Backup Client], and {url-analytics}[Couchbase Analytics] repositories.
• Production branches use the release/X.Y naming pattern (e.g., release/5.5, release/6.0). ** The {url-playbook}[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 {url-ui}[site UI] are orchestrated by the {url-playbook}[docs site playbook]. See the contributing guide to learn more.

== License

Couchbase Server Documentation © 2024 by Couchbase Inc. is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.

See the LICENSE file or the {url-license}[Creative Commons CC BY-NC-SA 4.0 license page] for details.