Commit Graph

2 Commits

Author SHA1 Message Date
Marco Nenciarini
fee70c33e4
fix(docs): filter Optional markers from validation column
The crd-ref-docs tool automatically recognizes the +optional marker
comments in Go code and renders them as validation entries. A recent
upstream change in github.com/elastic/crd-ref-docs master branch
started rendering these as `Optional: {}` text in the validation
column, which looks like an empty JSON object and is redundant since
the Required column already shows this information.

Update the documentation template to filter out these Optional markers
while preserving meaningful validation rules like patterns and enums.
Also remove the now-redundant customMarkers configuration, as the
current version of crd-ref-docs recognizes the optional marker without
explicit configuration.

Closes #722

Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
2026-01-09 18:18:35 +01:00
Francesco Canovai
a592793572
docs: publish docs with docusaurus (#268)
Rework the documentation to be a static website instead of just the
GitHub README.md. Use docusaurus to create the website, and the CI to
publish to GitHub pages on commits to main.
Block `release-please` releases unless the documentation for that version
has been generated.

Closes #244

Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Co-authored-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
2025-04-30 12:17:57 +02:00