Skip to content

Opt-in property references through the prop macro (v/26.1) - #1897

Draft
JakeSCahill wants to merge 1 commit into
v/26.1from
DOC-887-prop-migration-v26.1
Draft

Opt-in property references through the prop macro (v/26.1)#1897
JakeSCahill wants to merge 1 commit into
v/26.1from
DOC-887-prop-migration-v26.1

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

In plain English

Same change as the main-branch migration (#1896), for the 26.1 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 (v26.1.14) — the macro is version-aware, so 26.1 pages validate against 26.1 data and link only within 26.1 pages.

⚠️ Dependencies — do not merge before

  1. docs-extensions-and-macros 5.15.0 published (the prop: macro): 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 for the docs repo previews, plus the docs-site playbook PR for production). Versioned branches inherit macros from the site build, so this content renders as literal prop:... text until registration lands.
  3. docs-ui Fix broker properties: suggestions for descriptions #415 (the tooltip cutover) should be released around the same time — without it, marked properties simply render as plain code (harmless).

Contents

  • 738 prose conversions across 77 files (validated against v26.1.14 JSON; admin, brokers, rack, retries, superusers left plain — those are the false-positive words that motivated opt-in).
  • All config_ref calls → prop with helm-path=auto (fixes the storage.tiered.config. mislabeling of non-tiered properties on Kubernetes pages).
  • Overrides, generated partials, and the published JSON attachment converted to match extractor output (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.

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

Backport of the property-reference migration to the 26.1 branch,
validated against this branch's own published JSON
(redpanda-properties-v26.1.14.json): plain-backtick property mentions
in prose become prop macro calls (738 across 77 files, 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.
@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: 5219f951-04d8-4c6d-9899-1d4ab4f49fae

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