docs: point production K8s pages at the local kind/minikube guide (DOC-517) - #1888
Open
JakeSCahill wants to merge 1 commit into
Open
docs: point production K8s pages at the local kind/minikube guide (DOC-517)#1888JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
…C-517) Users browsing the production workflow or deployment page had no signpost to the local development guide. Add a TIP on both entry points.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughAdded tips to the production Kubernetes deployment and workflow pages. The tips direct users who need local development or testing guidance to the kind and minikube deployment guide. Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adoc (1)
11-12: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse empty xref brackets for both local-guide links.
Both tips hard-code display text for the same destination. Use
xref:deploy:redpanda/kubernetes/local-guide.adoc[]so the published link text follows the target document title.
modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adoc#L11-L12: Replace the hard-coded link label with an empty xref label.modules/deploy/pages/redpanda/kubernetes/k-production-workflow.adoc#L10-L11: Replace the hard-coded link label with an empty xref label.Based on learnings, prefer empty xref brackets in AsciiDoc links.
🤖 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 `@modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adoc` around lines 11 - 12, Replace the hard-coded local-guide link label with an empty xref label in modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adoc lines 11-12 and modules/deploy/pages/redpanda/kubernetes/k-production-workflow.adoc lines 10-11, preserving the existing destination so the published text comes from the target document title.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 `@modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adoc`:
- Around line 11-12: Replace the hard-coded local-guide link label with an empty
xref label in
modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adoc lines
11-12 and modules/deploy/pages/redpanda/kubernetes/k-production-workflow.adoc
lines 10-11, preserving the existing destination so the published text comes
from the target document title.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 004c466d-a58b-402e-b408-cc1d99e6cfc2
📒 Files selected for processing (2)
modules/deploy/pages/redpanda/kubernetes/k-production-deployment.adocmodules/deploy/pages/redpanda/kubernetes/k-production-workflow.adoc
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
1 participant
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.
Resolves DOC-517: a user browsing the production deployment docs had no signpost to the local kind/minikube guide and had to find it through search.
Adds a TIP to the two production entry points (
k-production-workflowandk-production-deployment) linking the local development guide. The xref target is the existinglocal-guide.adocpage. Two-line change, no structural impact. The Netlify preview validates the links.🤖 Generated with Claude Code