Preliminary Checks
Summary
Add a make docs target (or equivalent) to nebari-operator that generates a NicApp CRD reference in markdown from the CRD schema, so nebari-docs can pull it at build time without hand-edited pages drifting from the code.
Related: nebari-dev/nebari-docs#665
Work
Generate NicApp CRD reference markdown
- Tooling:
crd-ref-docs (or controller-gen with a doc plugin) invoked via a make docs target
- Source: the CRD definition produced by
controller-gen from the operator's Go types
- Output: a single markdown file with a field-by-field reference table and annotated examples, emitted to a known path (e.g.
docs/nicapp-crd-reference.md)
Wire into CI
- Add a CI step that runs the generator and fails the build if:
- the generator errors, or
- the output is stale (generated content does not match the committed file — enforce with
git diff --exit-code)
Acceptance criteria
Notes
nebari-docs will pull this generated file at build time (via git submodule, released artifact, or a sync script — the mechanism is decided on the nebari-docs side)
- Field descriptions shown in the reference come from
// +kubebuilder:validation markers and Go doc comments on the struct fields — make sure those are present and accurate before the generator runs
Preliminary Checks
Summary
Add a
make docstarget (or equivalent) tonebari-operatorthat generates aNicAppCRD reference in markdown from the CRD schema, sonebari-docscan pull it at build time without hand-edited pages drifting from the code.Related: nebari-dev/nebari-docs#665
Work
Generate
NicAppCRD reference markdowncrd-ref-docs(orcontroller-genwith a doc plugin) invoked via amake docstargetcontroller-genfrom the operator's Go typesdocs/nicapp-crd-reference.md)Wire into CI
git diff --exit-code)Acceptance criteria
make docs(or equivalent) generatesNicAppCRD reference markdown from the CRD schemanebari-docscan referenceNotes
nebari-docswill pull this generated file at build time (via git submodule, released artifact, or a sync script — the mechanism is decided on thenebari-docsside)// +kubebuilder:validationmarkers and Go doc comments on the struct fields — make sure those are present and accurate before the generator runs