Couchbase Service Broker Documentation

This repository hosts the documentation source for the Couchbase Service Broker. The published documentation can be found here.

Note that this documentation is based, in part, on documentation from the Couchbase-maintained Kubernetes Generic Service Broker.

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.

Note	Some contributions to this documentation may be selectively ported to the Couchbase-maintained Kubernetes Generic Service Broker.

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.

• Production branches use the x.0.y naming pattern adopted from the Couchbase Autonomous Operator and Couchbase Service Broker.

Documentation Site Toolchain

The documentation source files are marked up with AsciiDoc. Once merged into branch master, 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.