Skip to content

The Couchbase Server documentation source files (in AsciiDoc) used in the Couchbase Docs site.

License

Notifications You must be signed in to change notification settings

malarky/docs-server

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

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 Creative Commons CC BY-NC-SA 4.0 license page for details.

About

The Couchbase Server documentation source files (in AsciiDoc) used in the Couchbase Docs site.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 99.5%
  • Other 0.5%