Skip to content

docs: label default namespace before applying base resources#625

Merged
LakshanSS merged 1 commit into
openchoreo:mainfrom
VajiraPrabuddhaka:docs/install-default-resources-order
May 15, 2026
Merged

docs: label default namespace before applying base resources#625
LakshanSS merged 1 commit into
openchoreo:mainfrom
VajiraPrabuddhaka:docs/install-default-resources-order

Conversation

@VajiraPrabuddhaka
Copy link
Copy Markdown
Contributor

@VajiraPrabuddhaka VajiraPrabuddhaka commented May 15, 2026

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 so kubectl label namespace runs before kubectl apply -f all.yaml
  • on-your-environment.mdx: move the label step above the apply step and update the surrounding sentence

Related Issues

N/A

Checklist

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

Signed-off-by: VajiraPrabuddhaka <vajiraprabuddhaka@gmail.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7a3b1784-604d-4990-80cc-570261b1fa45

📥 Commits

Reviewing files that changed from the base of the PR and between 860cb11 and 3841259.

📒 Files selected for processing (2)
  • docs/getting-started/try-it-out/on-k3d-locally.mdx
  • docs/getting-started/try-it-out/on-your-environment.mdx

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated getting-started guides with revised instructions for the "Install Default Resources" step. The sequence of kubectl commands has been reordered to adjust the timing of namespace labeling and resource application across both local k3d-based and standard environment deployments.

Walkthrough

This 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.

Changes

Documentation: Step 4 kubectl Command Sequencing

Layer / File(s) Summary
on-k3d-locally guide Step 4 kubectl reordering
docs/getting-started/try-it-out/on-k3d-locally.mdx
kubectl apply for all.yaml is repositioned to execute before the namespace control-plane label is applied.
on-your-environment guide Step 4 kubectl reordering
docs/getting-started/try-it-out/on-your-environment.mdx
kubectl label for the default namespace is repositioned to execute before the kubectl apply command for all.yaml resources.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: reordering commands to label the default namespace before applying base resources, which is the core fix across both documentation files.
Description check ✅ Passed The description follows the template with a clear Purpose section explaining the fix, an Approach section detailing changes to both files, and a completed Checklist. All required sections are present and substantive.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@LakshanSS LakshanSS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@LakshanSS LakshanSS merged commit 3d7cedd into openchoreo:main May 15, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants