https://github.com/couchbase/docs-sdk-ruby

Couchbase Ruby SDK documentation (asciidoc)
https://github.com/couchbase/docs-sdk-ruby

docs sdk

Last synced: 5 months ago
JSON representation

Couchbase Ruby SDK documentation (asciidoc)

• Host: GitHub
• URL: https://github.com/couchbase/docs-sdk-ruby
• Owner: couchbase
• License: other
• Created: 2018-08-22T22:50:10.000Z (almost 8 years ago)
• Default Branch: release/3.4
• Last Pushed: 2026-01-16T16:33:19.000Z (5 months ago)
• Last Synced: 2026-01-17T04:52:59.846Z (5 months ago)
• Topics: docs, sdk
• Language: Ruby
• Homepage: https://docs.couchbase.com
• Size: 1.15 MB
• Stars: 1
• Watchers: 13
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= Couchbase Ruby SDK Documentation

// Settings:

ifndef::env-github[:icons: font]

ifdef::env-github[]

:warning-caption: :warning:

endif::[]

// URLs:

:url-org: https://github.com/couchbase

:url-ui: {url-org}/docs-ui

:url-playbook: {url-org}/docs-site

Documentation component for the renewed Couchbase Ruby 3.x SDK.

== 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 of the modules is stored in the ROOT module's _nav.adoc_ file.

* 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.