docs: OCM version, Helm output, WDS wording, BindingPolicy typo, marketplace link (#1445-#1450)#1451
Conversation
…po, marketplace link - Clarify OCM CLI v0.10.x constraint with explanation of why v0.11+ is incompatible (ServiceAccount name change) (#1445) - Add expected Helm install output to Getting Started guide so users can verify success (#1446) - Soften WDS creation wording from "only documented way" to "recommended way" and document the KubeFlex CLI alternative (#1447) - Fix BidingPolicy -> BindingPolicy typo in troubleshooting.md (#1448) - Fix marketplace link in DocsFooter to match header (/marketplace) (#1450) Signed-off-by: Andrew Anderson <andy@clubanderson.com>
|
/lgtm |
|
/approve |
kubestellar-prow
bot
added
the
dco-signoff: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: clubanderson The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubestellar-prow
bot
added
the
approved
|
@clubanderson: you cannot LGTM your own PR. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
✅ Deploy Preview for kubestellar-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
kubestellar-prow
bot
added
the
size/M
❌ PR Title Verification FailedYour PR title does not follow the required format. Current title: Required FormatPR titles must start with one of these emoji prefixes:
How to FixEdit your PR title to start with the appropriate emoji. For example:
You can edit the title by clicking the Edit button next to your PR title. This comment was automatically posted by the PR Title Verifier workflow. |
github-actions
bot
added
documentation
There was a problem hiding this comment.
Pull request overview
Updates KubeStellar documentation and site navigation to clarify tool version constraints, improve onboarding feedback, refine WDS creation guidance, fix a troubleshooting typo, and align Marketplace navigation links.
Changes:
- Clarifies the
clusteradm(OCM CLI) version constraint rationale and required version guidance. - Adds inline example output for
helm upgrade --installso users can verify a successful install. - Adjusts WDS creation wording, fixes
BindingPolicytypo, and updates DocsFooter Marketplace link.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/kubestellar/pre-reqs.md | Adds rationale for the 0.10.x clusteradm requirement and installation guidance. |
| docs/content/kubestellar/get-started.md | Includes expected Helm output and clarifies next steps after install. |
| docs/content/kubestellar/wds.md | Reframes Helm as the recommended approach and documents a supported advanced alternative. |
| docs/content/kubestellar/troubleshooting.md | Fixes BidingPolicy → BindingPolicy typo. |
| src/components/docs/DocsFooter.tsx | Updates the Marketplace footer link to /marketplace for consistency. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Note:** KubeStellar specifically requires clusteradm **v0.10.x**. Versions 0.11 and later introduced an incompatible change in a ServiceAccount name that breaks KubeStellar's OCM integration. Although OCM has released newer versions (v0.11+, v1.x), you **must** use v0.10.1 with the current KubeStellar release. | ||
|
|
||
| To install the required version of the OCM CLI use: |
There was a problem hiding this comment.
The version guidance is internally inconsistent: the bullet says any 0.10.x is acceptable, but the note then says users must use v0.10.1 specifically. If any 0.10.x works, rephrase to “use v0.10.x (tested with v0.10.1)” or similar; if only v0.10.1 works, tighten the earlier constraint to match and explain why other 0.10 patch versions won’t work.
| **Note:** KubeStellar specifically requires clusteradm **v0.10.x**. Versions 0.11 and later introduced an incompatible change in a ServiceAccount name that breaks KubeStellar's OCM integration. Although OCM has released newer versions (v0.11+, v1.x), you **must** use v0.10.1 with the current KubeStellar release. | |
| To install the required version of the OCM CLI use: | |
| **Note:** KubeStellar specifically requires clusteradm **v0.10.x**. Versions 0.11 and later introduced an incompatible change in a ServiceAccount name that breaks KubeStellar's OCM integration. Although OCM has released newer versions (v0.11+, v1.x), you should use a **v0.10.x** release with the current KubeStellar release; **v0.10.1** is the version that has been tested with this documentation. | |
| To install a tested version of the OCM CLI, use: |
| That command will print output similar to the following, indicating a successful installation: | ||
|
|
||
| ```console | ||
| Release "ks-core" does not exist. Installing it now. | ||
| NAME: ks-core | ||
| LAST DEPLOYED: <timestamp> | ||
| NAMESPACE: default | ||
| STATUS: deployed | ||
| REVISION: 1 | ||
| TEST SUITE: None | ||
| NOTES: | ||
| For your convenience you will probably want to add contexts to your | ||
| kubeconfig named after the non-host-type control planes (WDSes and | ||
| ITSes) that you just created ... | ||
|
|
There was a problem hiding this comment.
The Helm output example includes first-install specific text (e.g., "Release ... does not exist. Installing it now.") and an ellipsis line in the NOTES section. Consider adjusting the intro/text to clarify what parts are placeholders/omissions and that upgrades will look different; otherwise readers may treat the snippet as exact output to expect/copy.
| <li> | ||
| <Link | ||
| href="/docs/console/marketplace" | ||
| href="/marketplace" | ||
| className={`text-xs sm:text-sm transition-colors duration-200 inline-block ${ | ||
| isDark |
There was a problem hiding this comment.
This link points to a locale-prefixed route (served from src/app/[locale]/marketplace), but DocsFooter uses next/link with a non-localized href. Elsewhere the app uses the locale-aware Link from @/i18n/navigation for localized routes; consider using that here (or generating a localized URL) to avoid relying on middleware redirects and to preserve the user’s selected locale.
🔄 Auto-Applying Copilot Code ReviewCopilot code review found 1 code suggestion(s) and 2 general comment(s). @copilot Please apply all of the following code review suggestions:
Also address these general comments:
Push all fixes in a single commit. Run Auto-generated by copilot-review-apply workflow. |
📖 Preview LinksThe following documentation pages were changed in this PR:
|
|
Thank you for your contribution! Your PR has been merged. Check out what's new:
Stay connected: Slack #kubestellar-dev | Multi-Cluster Survey |
Closes #1445
Closes #1446
Closes #1447
Closes #1448
Closes #1450
Summary
helm upgrade --installoutput inline in the Getting Started guide so users can verify success without cross-referencing core-chart.md.BidingPolicy→BindingPolicyin troubleshooting.md. Searched entire repo — only one instance found./docs/console/marketplaceto/marketplaceto match header/DocsNavbar links.Files changed (5)
docs/content/kubestellar/pre-reqs.md— OCM version constraint clarificationdocs/content/kubestellar/get-started.md— added Helm expected outputdocs/content/kubestellar/wds.md— softened WDS creation wordingdocs/content/kubestellar/troubleshooting.md— BindingPolicy typo fixsrc/components/docs/DocsFooter.tsx— marketplace link consistency