Skip to content

Add CrateDB CRD reference page - #902

Open
tomach wants to merge 1 commit into
masterfrom
ta/crd-reference
Open

Add CrateDB CRD reference page#902
tomach wants to merge 1 commit into
masterfrom
ta/crd-reference

Conversation

@tomach

@tomach tomach commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Summary of changes

Adds a new documentation page, CrateDB CRD reference (docs/source/crd-reference.rst), and links it into the toctree in index.rst.

The operator's cratedbs.cloud.crate.io CRD had no human-readable reference. Since we recommend the operator for self-hosted deployments, this fills that gap with a single page describing the important settings and where they go.

Checklist

  • Link to issue this PR refers to: https://github.com/crate/cloud/issues/3104
  • Relevant changes are reflected in CHANGES.rst
  • Added or changed code is covered by tests
  • Documentation has been updated if necessary
  • Changed code does not contain any breaking changes (or this is a major version change)

@tomach
tomach marked this pull request as ready for review September 8, 2026 08:35
Comment thread docs/source/crd-reference.rst

@plaharanne plaharanne left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants