Repository navigation
[release/v26.2.x] operator: link cloud_storage_* field docs to the object storage page (#2001) - #2005
Merged
Merged
Conversation
Backport of #2001. The cloud_storage_* field comments in RedpandaClusterSpec.config linked to the cluster and tunable properties pages with anchors that only exist on the object storage properties page. Point the 29 links there and regenerate the CRD manifest and the crd-docs testdata.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
The thread-per-core section's anchor is tpc, not thread-per-core-model, so the link landed at the top of the page and the docs link converter leaves it as a raw URL. Comment-only change; the CRD bases and the crd-docs test fixture carry the same text.
JakeSCahill
marked this pull request as ready for review
October 23, 2026 13:04
JakeSCahill
requested review from
RafalKorepta,
andrewstucki,
chrisseto,
gene-redpanda and
hidalgopl
as code owners
October 23, 2026 13:04
hidalgopl
approved these changes
Oct 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport of #2001 to
release/v26.2.x.The
cloud_storage_*field comments inRedpandaClusterSpec.configlink to anchors on the wrong page. The anchors exist only on the object storage properties page, but the links point at the cluster and tunable properties pages, so readers of the CRD reference andkubectl explainland on a page without the property. This points the 29 links at the object storage properties page.//comment lines (58 changed lines, all comments).testdata/crd-docs.adocare regenerated on this branch with the pinned tools (controller-gen 0.20.1, crd-ref-docs 0.3.0), running the commands fromk8s:generate. A regeneration of the unmodified branch had no drift first.The changelog entry from #2001 is included, so 26.2 patch release notes list the fix.