Move the shared component to a folder on main and add the enterprise features registry - #1892
Open
JakeSCahill wants to merge 4 commits into
Open
Move the shared component to a folder on main and add the enterprise features registry#1892JakeSCahill wants to merge 4 commits into
JakeSCahill wants to merge 4 commits into
Conversation
…prise features registry The shared Antora component (glossary terms, valid categories, global attributes) moves from the shared branch to shared/ on main, added to the playbook as a second content source with start_path: shared. Registry entries, the prose that uses them, and table changes can now land atomically in one PR with normal CODEOWNERS review. shared/modules/ROOT/partials/enterprise-features.yml is the new canonical registry of enterprise features, seeded verbatim from the four tables in get-started:licensing/overview.adoc. The enterprise macro validates its targets against this registry and the enterprise_features block macro renders the licensing tables from it (docs-extensions-and-macros).
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedToo many files! This PR contains 141 files, which is 41 over the limit of 100. To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (141)
You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…cas gating property Found by the doc-tools validate enterprise-features drift checker comparing the registry against disable-enterprise-features.adoc.
This was referenced Aug 7, 2026
Some enterprise features have separate documentation for Kubernetes, Linux, and Redpanda Cloud. New optional xref-kubernetes and xref-cloud fields let the enterprise macro link to the environment-appropriate page based on the env-kubernetes and env-cloud page attributes, following the config_ref macro's environment-awareness pattern. The default xref stays the Linux / generic self-managed page.
This was referenced Aug 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In plain English
Nothing stopped a writer from calling any feature "enterprise," under any name -- a typo or a wrong claim would ship silently. This PR creates one reviewed file that is the official list: which features are enterprise, what each is called externally, and a pointer to the internal proof (the actual license gate in Redpanda's source, Connect's plugin list, or a written justification). Everything downstream -- the styled enterprise mentions in prose, the licensing feature tables, the CI check against engineering's code -- reads from this file, so the docs can only say what the registry says. It also moves the shared content (glossary terms and this registry) from a separate git branch into a normal folder on main, so adding a feature and using it happens in one ordinary pull request instead of two.
Description
Part of the enterprise-marking governance work for DOC-887.
Shared component: branch → folder
The
sharedAntora component (134 glossary terms,valid-categories.yml, global attributes) moves from thesharedbranch into ashared/folder onmain. The playbook consumes it as a second content source pointing at the same repo withstart_path: shared— the same mechanism this playbook already uses for redpanda-labs (start_paths: [docs, '*/docs']).Why: content in the shared component can now change atomically with the pages that use it, in one normal PR with normal CODEOWNERS review and squash merge. The old flow needed a separate PR against the
sharedbranch first.The
sharedbranch stays untouched until every consuming playbook (docs-site ×3, rp-connect-docs, cloud-docs, adp-docs, docs-template, redpanda-labs) has cut over. Follow-up PRs handle those. Only then does the branch get retired.New: enterprise features registry
shared/modules/ROOT/partials/enterprise-features.ymlis the canonical registry of enterprise features: approved external names, aliases, scope, feature xref, table content (description + expiration behavior), and a pointer to the internal source of truth for each entry (corelicense_required_featureenum value,config::enterprise<>property, connectinfo.csv, or a manual justification).Seeded verbatim from the four tables in
get-started:licensing/overview.adoc. Two intentional deviations:(StretchCluster resource), gating-property notes) are modeled as structured fields.Consumers land separately in docs-extensions-and-macros: the
enterprise:inline macro validates its targets against this registry (unknown name = build warning, later error), and a newenterprise_features::[scope]block macro renders the licensing tables from it so the tables can never drift from the registry.CODEOWNERS gets an explicit entry for the registry file.
Validation
Full local Antora build passes with the folder component: the glossary page aggregates all terms, zero "not yet defined" fallbacks on current, only pre-existing warnings.