Skip to content

Opt-in property references through the prop macro (v/25.3) - #1898

Draft
JakeSCahill wants to merge 1 commit into
v/25.3from
DOC-887-prop-migration-v25.3
Draft

Opt-in property references through the prop macro (v/25.3)#1898
JakeSCahill wants to merge 1 commit into
v/25.3from
DOC-887-prop-migration-v25.3

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

In plain English

Same change as the main-branch migration (#1896) and the 26.1 backport (#1897), for the 25.3 docs: property mentions are explicitly marked and build-verified instead of guessed by the UI, and the deprecated config_ref macro is gone from this branch's content. Every converted name was validated against this branch's own published property data (v25.3.11) — the macro is version-aware, so 25.3 pages validate against 25.3 data and link only within 25.3 pages.

⚠️ Dependencies — do not merge before

  1. docs-extensions-and-macros 5.7.0 published (merge order Clarify that we do not support autoscalers #249 → #253 → UBB - Private Offers for Dedicated #251Update minimum subnet ip range #254).
  2. The site playbooks register the macro (docs#1896 + the docs-site playbook PR). Until then this content renders as literal prop:... text.
  3. docs-ui Fix broker properties: suggestions for descriptions #415 released around the same time (without it, marked properties render as plain code — harmless).

Contents

  • 729 prose conversions across 65 files, validated against v25.3.11 JSON; the 5 ambiguous names left plain.
  • All config_ref calls → prop with helm-path=auto.
  • Overrides, generated partials, and the published JSON attachment converted (the JSON was leaking raw macro text into tooltips).
  • Same two manual fixes as main: inlined {config-ref} indirection, removed the dead cloud_storage_reconciliation_interval_ms row.

Older branches (v/25.2 and earlier)

Deliberately not migrated: those branches publish no property JSON, so there is no version-correct data to validate names against, and the UI already disables tooltips there. config_ref stays registered site-wide, so their content keeps rendering exactly as today.

Full explainer: macros/PROPERTY_AND_ENTERPRISE_REFERENCES.adoc in docs-extensions-and-macros#254.

Backport of the property-reference migration to the 25.3 branch,
validated against this branch's own published JSON
(redpanda-properties-v25.3.11.json): 729 plain-backtick property
mentions across 65 files become prop macro calls (the five ambiguous
separator-free names deliberately left plain), all config_ref calls
become prop calls with helm-path=auto, and the overrides file, generated
partials, and published JSON attachment are converted to match what the
fixed property extractor emits.

Includes the same two manual fixes as main: the single-use {config-ref}
attribute indirection is inlined, and the table row for the removed
cloud_storage_reconciliation_interval_ms property is deleted.
@netlify

netlify Bot commented Aug 9, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 99dfb5f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a7812670ec6a50008022861
😎 Deploy Preview https://deploy-preview-1898--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: dba556a6-4fcb-452b-b3b8-574b14a6b586

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant