Register the enterprise and prop macros site-wide and consume the shared folder - #205
Draft
JakeSCahill wants to merge 1 commit into
Draft
Register the enterprise and prop macros site-wide and consume the shared folder#205JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
…he shared folder Registers the enterprise and prop macros (docs-extensions-and-macros >= 5.7.0) with warn-level validation attributes in all three playbooks, enabling the registry-validated enterprise markings and opt-in property references landing across the content repos and their versioned branches. Also cuts the shared component over from the retired shared branch to the shared/ folder on docs main (start_path source), matching the docs repo's own playbook.
❌ Deploy Preview for redpanda-documentation failed. Why did it fail? →
|
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
This is the production switch for two systems landing across the content repos: enterprise feature mentions that are validated against a canonical registry, and property references that are explicitly marked and verified against the published property data (instead of the UI guessing from text). Content in those repos is written with the new
enterprise:andprop:macros — until the site playbooks register the macros, that content renders as literal macro text. This PR registers both macros in all three playbooks with warn-level validation, and switches the shared component source from the retiredsharedbranch to theshared/folder on docs main.shared/folder must exist on docs main before thestart_path: sharedsource resolves).Why warn-level validation
enterprise-validate: warnandproperty-validate: warnlog unknown names with file paths and suggestions without failing production builds. Once the content PRs are in and builds are clean, both can flip toerrorso a typo'd property or a made-up enterprise feature fails CI instead of shipping.Full explainer:
macros/PROPERTY_AND_ENTERPRISE_REFERENCES.adocin docs-extensions-and-macros#254.