docs: label default namespace before applying base resources#625
Conversation
Signed-off-by: VajiraPrabuddhaka <vajiraprabuddhaka@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR reorders kubectl command execution in Step 4 ("Install Default Resources") across two getting-started guide variations. The on-k3d-locally guide now applies the sample resources before labeling the namespace, while the on-your-environment guide applies the label before the sample resources, establishing opposite sequencing in each environment type. ChangesDocumentation: Step 4 kubectl Command Sequencing
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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 |
Purpose
In the "Install Default Resources" step of both getting-started guides, the namespace label was applied after
kubectl apply -f all.yaml. Reordering these commands — labeling the namespace first — fixes some intermittent Backstage sync failures seen when the resources are applied before the namespace is marked as a control plane.Approach
on-k3d-locally.mdx: flip the chained command sokubectl label namespaceruns beforekubectl apply -f all.yamlon-your-environment.mdx: move the label step above the apply step and update the surrounding sentenceRelated Issues
N/A
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors