Skip to content

Latest commit

 

History

History
10 lines (8 loc) · 789 Bytes

File metadata and controls

10 lines (8 loc) · 789 Bytes

CRD documentation

The CRD reference{external-link-icon} on the Stackable Hub is generated from the CRD manifest files, which are in turn generated from the operator source code. All the documentation strings are doc strings in the Rust source code. If you want to contribute documentation for a particular field, this needs to be done in doc string of the property on the struct that makes up that part of the CRD.

The Hub ingests the CRDs of every operator automatically, so no manual steps are needed to publish the reference. If you spot a problem with how the reference is rendered, file an issue in the issues repository{external-link-icon}.