Remove beta label from Iceberg docs #368
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis change updates documentation configuration and content related to Iceberg topics. The Antora playbook is modified to track a specific feature branch instead of the main branch for the documentation source. Several Iceberg documentation pages have the Sequence Diagram(s)sequenceDiagram
participant User
participant Antora
participant GitHubRepo
User->>Antora: Build documentation
Antora->>GitHubRepo: Fetch sources from 'DOC-1513-please-document-new-iceberg-property', v/*, api, shared, site-search
GitHubRepo-->>Antora: Return documentation content
Antora->>User: Generate site with updated Iceberg docs (no beta labels, reordered tags)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
local-antora-playbook.yml (1)
18-18: Validate long-lived playbook pin before mergingPointing the build to a feature branch is useful while the work is in flight, but once the property is merged back to
mainthis reference can silently diverge and freeze the docs site on an outdated branch.Consider one of the following before merging to
main:
- Revert the playbook line back to
main, or- Add a clear TODO/issue to flip it back immediately after the feature branch is closed.
This avoids accidental bit-rot in CI/CD pipelines that rely on this playbook.
modules/reference/pages/properties/cluster-properties.adoc (1)
11-11: Tag list is drifting out of alphabetical orderThe include tag list now contains a mix of ordered and unordered segments and duplicates two semantically similar properties:
... iceberg_rest_catalog_base_location;iceberg_rest_catalog_endpoint; ... iceberg_catalog_base_location; ...For long-term maintainability consider:
- Sorting the tags alphabetically (makes diffs smaller & merge-friendly).
- Verifying that both
iceberg_catalog_base_locationandiceberg_rest_catalog_base_locationare intentionally distinct and documented—otherwise one may be redundant.No functional breakage, but a quick tidy-up now prevents confusion later.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
local-antora-playbook.yml(1 hunks)modules/manage/pages/iceberg/about-iceberg-topics.adoc(0 hunks)modules/manage/pages/iceberg/choose-iceberg-mode.adoc(0 hunks)modules/manage/pages/iceberg/index.adoc(1 hunks)modules/manage/pages/iceberg/query-iceberg-topics.adoc(0 hunks)modules/manage/pages/iceberg/use-iceberg-catalogs.adoc(0 hunks)modules/reference/pages/properties/cluster-properties.adoc(1 hunks)
💤 Files with no reviewable changes (4)
- modules/manage/pages/iceberg/use-iceberg-catalogs.adoc
- modules/manage/pages/iceberg/about-iceberg-topics.adoc
- modules/manage/pages/iceberg/query-iceberg-topics.adoc
- modules/manage/pages/iceberg/choose-iceberg-mode.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (1)
modules/manage/pages/iceberg/index.adoc (1)
3-3: Removal of:page-beta:looks goodThe beta flag has been successfully removed and the remaining header attributes render correctly. No further action required.
Description
Related PR to add
iceberg_rest_catalog_base_locationto cluster property reference: redpanda-data/docs#1238This pull request includes updates to the Iceberg-related documentation and configuration in the project. The changes primarily focus on removing the beta status of Iceberg features, adding a new branch to the Antora playbook, and updating cluster property tags to include a new Iceberg-related property.
Documentation Updates
:page-beta: trueattribute from multiple Iceberg-related documentation files, indicating that these features are no longer in beta. Files updated include:modules/manage/pages/iceberg/about-iceberg-topics.adocmodules/manage/pages/iceberg/choose-iceberg-mode.adocmodules/manage/pages/iceberg/index.adocmodules/manage/pages/iceberg/query-iceberg-topics.adocmodules/manage/pages/iceberg/use-iceberg-catalogs.adocConfiguration Updates
local-antora-playbook.yml) to include a new branch,DOC-1513-please-document-new-iceberg-property, for documentation purposes.iceberg_rest_catalog_base_locationproperty to the list of cluster properties inmodules/reference/pages/properties/cluster-properties.adoc. This ensures the property is documented and included in the configuration.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
Manage > Iceberg
Checks