Skip to content

feat(crd-docs): mark beta CRDs with (beta) heading suffix and badge #1833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JakeSCahill merged 3 commits into from
Jul 28, 2026
+18 −2
Merged

feat(crd-docs): mark beta CRDs with (beta) heading suffix and badge #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
015ddeb
feat(crd-docs): mark beta CRD types with (beta) heading suffix and badge
JakeSCahill Jul 28, 2026
161836c
docs: include NamedValueSource in the beta CRD pattern
Feediver1 Jul 28, 2026
51a025f
fix: mark only Pipeline types as beta, Stretch and ShadowLink are GA
JakeSCahill Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions .github/crd-config/templates/asciidoctor/operator/type.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
{{- define "type" -}}
{{- $type := . -}}
{{- /*
Beta CRD marking: types whose names match this pattern document beta features.
They get a plain (beta) suffix on the section heading and a badge::[label=beta]
line at the start of the section body. The explicit [id=...] anchor above each
heading is untouched, so existing xrefs keep working.
Update this pattern when features graduate to GA or new beta CRDs are added.
Pipeline* = Pipeline CRD (beta in 26.2). NamedValueSource (exact match) is a
Pipeline-only supporting type that does not share the prefix. The shared
ValueSource type predates Pipeline and stays GA. StretchCluster and ShadowLink
are GA in 26.2 and deliberately not listed.
*/ -}}
{{- $betaTypePattern := "^(Pipeline|NamedValueSource$)" -}}
{{- $isBeta := regexMatch $betaTypePattern $type.Name -}}
{{- if asciidocShouldRenderType $type -}}

[id="{{ asciidocTypeID $type | asciidocRenderAnchorID }}"]
== {{ $type.Name }} {{ if $type.IsAlias }}({{ asciidocRenderTypeLink $type.UnderlyingType }}) {{ end }}
== {{ $type.Name }} {{ if $type.IsAlias }}({{ asciidocRenderTypeLink $type.UnderlyingType }}) {{ end }}{{ if $isBeta }}(beta){{ end }}

{{ $type.Doc }}
{{ if $isBeta }}badge::[label=beta]

{{ end }}{{ $type.Doc }}

{{ if eq $type.Name "RedpandaClusterSpec" }}
For descriptions and default values, see xref:k-redpanda-helm-spec.adoc[].
Expand Down
1 change: 1 addition & 0 deletions local-antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ asciidoc:
- '@redpanda-data/docs-extensions-and-macros/macros/glossary'
- '@redpanda-data/docs-extensions-and-macros/macros/config-ref'
- '@redpanda-data/docs-extensions-and-macros/macros/helm-ref'
- '@redpanda-data/docs-extensions-and-macros/macros/badge'
- '@redpanda-data/docs-extensions-and-macros/asciidoc-extensions/add-line-numbers-highlights'
antora:
extensions:
Expand Down
Loading