auto-docs: Update property docs for tag v26.1.14#1824
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation release metadata advances to Redpanda 26.1.14. Three configuration properties are added to the reference data, property overrides, release comparison data, and cluster property documentation. Related metadata is adjusted for existing properties, including Schema Registry qualification visibility and development metrics version information. The previous version comparison data is replaced with a 26.1.13-to-26.1.14 comparison. Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs-data/property-overrides.json (1)
1376-1378: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winCompliant with version-only override convention; optional clarity/xref-style improvement available.
This entry correctly contains only
"version", consistent with the established convention that overrides should stay minimal unless a description override is intended. Optionally, since the base description inredpanda-properties-v26.1.14.jsonis a bit run-on ("...retention settings, local retention for topics with Tiered Storage enabled, and disk space management never remove their data...") and referenceskafka_nodelete_topicsas plain text rather than the<<kafka_nodelete_topics,kafka_nodelete_topics>>internal-link convention used elsewhere in the property set, you could add adescriptionoverride here for clarity and consistency. Not required for this PR.Based on learnings, "property entries may contain only a 'version' field; a 'description' field should only be present when the team intends to override the base property description... no other fields are introduced in these entries."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs-data/property-overrides.json` around lines 1376 - 1378, Keep the log_eviction_exempt_topics override limited to its existing version field. Do not add a description override or any additional fields, since no intentional description change is required.Source: Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs-data/property-overrides.json`:
- Around line 1376-1378: Keep the log_eviction_exempt_topics override limited to
its existing version field. Do not add a description override or any additional
fields, since no intentional description change is required.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 633fb465-dc15-40a6-92d6-d259c8845d05
📒 Files selected for processing (6)
antora.ymldocs-data/property-overrides.jsondocs-data/redpanda-property-changes-v26.1.12-to-v26.1.13.jsondocs-data/redpanda-property-changes-v26.1.13-to-v26.1.14.jsonmodules/reference/attachments/redpanda-properties-v26.1.14.jsonmodules/reference/partials/properties/cluster-properties.adoc
💤 Files with no reviewable changes (1)
- docs-data/redpanda-property-changes-v26.1.12-to-v26.1.13.json
This PR auto-generates updated Redpanda property documentation for v26.1.14.