http-proxy: Conditionalize links to Self-Managed topics #1315
Conversation
|
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 📝 WalkthroughWalkthroughIntroduces environment-conditional documentation in modules/develop/partials/http-proxy.adoc. The broker property http_proxy_auth_method is now shown only for non-cloud builds using ifndef::env-cloud[], while the cluster property http_authentication remains visible. Adds non-cloud-only cross-references directing readers to OIDC authentication docs. Similar OIDC cross-reference notes are inserted near the OIDC Authentication and Swagger sections to reflect cloud vs. non-cloud behavior consistently. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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 (1)
modules/develop/partials/http-proxy.adoc (1)
951-953: Good conditional xref; consider adding a Cloud-specific pointer (optional) and verify anchorHiding the OIDC configuration details for Cloud builds is appropriate. Optionally, add an ifdef::env-cloud[] note pointing Cloud readers to any Cloud-specific auth docs, if available. Also, please verify the
oidc-httpanchor exists.Use the same script in my other comment to validate the
oidc-httpanchor presence. If there’s a Cloud doc to reference, I can help add a conditional xref.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/develop/partials/http-proxy.adoc(2 hunks)
🔇 Additional comments (1)
modules/develop/partials/http-proxy.adoc (1)
856-862: No change needed — anchors present and link text follows repository conventionBoth anchors exist and the visible link text is consistent with how the property is referenced elsewhere, so no change is necessary.
- Current location: modules/develop/partials/http-proxy.adoc (lines ~859–861) — xref to broker http_proxy_auth_method and cluster http_authentication.
- Broker anchor: modules/reference/pages/properties/broker-properties.adoc — [[http_proxy_auth_method]] (used as <<http_proxy_auth_method,
authentication_method>>).- Cluster anchor: modules/reference/pages/properties/cluster-properties.adoc — === http_authentication (anchor present).
- OIDC anchor: modules/manage/partials/authentication.adoc — [[oidc-http]] (OIDC Authentication section).
Do not apply the proposed diff; keep the existing link text for consistency across the docs.
JakeSCahill
changed the title
Description
This pull request updates the HTTP Proxy documentation to improve clarity and tailor content for different deployment environments. The main changes reorganize and conditionally display authentication details based on whether the documentation is being built for a cloud environment.
Documentation improvements:
authentication_methodbroker property conditional so it only appears in non-cloud builds.Page previews
Checks