Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Oct 29, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1690

This pull request introduces automated generation and updating of Redpanda property documentation and related reference files, along with some configuration and metadata updates. The main focus is on improving the accuracy and maintainability of property docs by using a GitHub Actions workflow and updating version references and property mappings.

Automated documentation and reference updates:

  • Added a new GitHub Actions workflow (.github/workflows/update-property-docs.yml) to automatically generate property documentation, create pull requests for updates, and manage AWS credentials/secrets for secure automation.
  • Autogenerated new partials: modules/reference/partials/deprecated/deprecated-properties.adoc lists all deprecated configuration properties, and modules/reference/partials/topic-property-mappings.adoc maps topic properties to their corresponding cluster properties. These files are now maintained via automation and should not be edited manually. [1] [2]
  • Added a reference change log file (modules/reference/property-changes-v25.2.1-to-v25.2.10.json) summarizing property changes between versions, including changed defaults and types.

Configuration and metadata updates:

  • Updated antora.yml to reference the latest Redpanda release tag (v25.2.10), standardized YAML formatting, and improved home page and navigation metadata for clarity and consistency. [1] [2]
  • Updated local-antora-playbook.yml to include new branches and start paths for documentation sources, ensuring the latest docs and labs content are included in local builds.

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify
Copy link

netlify bot commented Oct 29, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 9277937
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69038b6df1b17500082154ce
😎 Deploy Preview https://deploy-preview-1428--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 29, 2025

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.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch config-automation

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 and usage tips.

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.

2 participants