[scanner] fix: repair broken links#6169
Merged
Merged
Conversation
Replace unresolved MkDocs template variables with actual version numbers.
All instances of {{ config.ks_latest_release }} and {{ config.ks_latest_regular_release }}
replaced with v0.30.0 from src/config/versions.ts.
Fixes #6168
Signed-off-by: Copilot <Copilot@users.noreply.github.com>
kubestellar-prow
Bot
added
the
dco-signoff: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ 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/S
github-actions
Bot
added
documentation
Contributor
📖 Preview LinksThe following documentation pages were changed in this PR:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses broken external links in the KubeStellar documentation caused by unresolved MkDocs template variables not being expanded in the Next.js pipeline. It fixes issue #6168 by replacing {{ config.ks_latest_release }} / {{ config.ks_latest_regular_release }} occurrences in URLs with the concrete version 0.30.0.
Changes:
- Replaced MkDocs template variables embedded in URLs with
v0.30.0across the affected docs pages. - Updated raw GitHub and pkg.go.dev links to point at the versioned tag/module path.
- Updated a docs.kubestellar.io “release-*” link to the concrete
release-0.30.0path.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/kubestellar/get-started.md | Replaced unresolved template variables in script download URLs with v0.30.0. |
| docs/content/kubestellar/binding.md | Updated pkg.go.dev API reference URLs to use @v0.30.0. |
| docs/content/kubestellar/acquire-hosting-cluster.md | Updated raw GitHub script URL to use v0.30.0. |
| docs/content/kubestellar/control.md | Updated pkg.go.dev API reference URL to use @v0.30.0. |
| docs/content/kubestellar/core-chart.md | Updated a GitHub script link and a docs.kubestellar.io release link to use 0.30.0. |
| docs/content/kubestellar/start-from-ocm.md | Replaced unresolved template variable in a script URL with v0.30.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```shell | ||
| bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v{{ config.ks_latest_release }}/scripts/setup-wsl-fedora.sh) | ||
| bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v0.30.0/scripts/setup-wsl-fedora.sh) |
|
|
||
| ```shell | ||
| bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v{{ config.ks_latest_release }}/scripts/create-kubestellar-demo-env.sh) --platform kind | ||
| bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v0.30.0/scripts/create-kubestellar-demo-env.sh) --platform kind |
|
|
||
| ```shell | ||
| bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v{{ config.ks_latest_release }}/scripts/create-kubestellar-demo-env.sh) --platform k3d | ||
| bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v0.30.0/scripts/create-kubestellar-demo-env.sh) --platform k3d |
|
|
||
| ```shell | ||
| curl -H "Cache-Control: no-cache" -L https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v{{ config.ks_latest_release }}/scripts/ocm-local-up-for-ingress.sh | bash | ||
| curl -H "Cache-Control: no-cache" -L https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v0.30.0/scripts/ocm-local-up-for-ingress.sh | bash |
| ``` | ||
|
|
||
| where `name` must specify a name unique among all the control planes in that KubeFlex deployment (note that this must be unique among both ITSes and WDSes), the optional `type` can be either k8s (default) or host, see [here](https://github.com/kubestellar/kubeflex/blob/main/docs/users.md) for more information, the optional `APIGroups` provides a list of APIGroups, see [here](https://docs.kubestellar.io/release-{{ config.ks_latest_release }}/kubestellar/examples-scenarios.md/#scenario-2-using-the-hosting-cluster-as-wds-to-deploy-a-custom-resource) for more information, and `ITSName` specify the ITS connected to the new WDS being created (this parameter MUST be specified if more that one ITS exists in the cluster, if no value is specified and only one ITS exists in the cluster, then it will be automatically selected). | ||
| where `name` must specify a name unique among all the control planes in that KubeFlex deployment (note that this must be unique among both ITSes and WDSes), the optional `type` can be either k8s (default) or host, see [here](https://github.com/kubestellar/kubeflex/blob/main/docs/users.md) for more information, the optional `APIGroups` provides a list of APIGroups, see [here](https://docs.kubestellar.io/release-0.30.0/kubestellar/examples-scenarios.md/#scenario-2-using-the-hosting-cluster-as-wds-to-deploy-a-custom-resource) for more information, and `ITSName` specify the ITS connected to the new WDS being created (this parameter MUST be specified if more that one ITS exists in the cluster, if no value is specified and only one ITS exists in the cluster, then it will be automatically selected). |
| When the ITS `type` is `external`, the `bootstrapSecret` sub-section can be used to indicate the bootstrap secret used by KubeFlex to connect to the external cluster. Specifically, it can be used to specify any combination of (a) the name of the secret, (b) the namespace containing the secret, and (c) the name of the key containing the kubeconfig of the external cluster if they need to be different from their default value. | ||
|
|
||
| If the secret was created using the [create-external-bootstrap-secret.sh](https://github.com/kubestellar/kubestellar/tree/v{{ config.ks_latest_release }}/scripts/create-external-bootstrap-secret.sh) script and the value passed to the argument `--controlplane` matches the name of the Control Plane specified by the Helm chart, then the sub-section `bootstrapSecret` is not required because all default values will identify the bootstrap secret created by the script. More specifically, if an external kind cluster was created with the command `kind create cluster --name its1` and the `create-external-bootstrap-secret.sh --controlplane its1 --verbose` command was used to create the bootstrap secret, then it would be enough to inform the Helm chart with `--set-json='ITSes=[{"name":"its1","type":"external"}]'`. | ||
| If the secret was created using the [create-external-bootstrap-secret.sh](https://github.com/kubestellar/kubestellar/tree/v0.30.0/scripts/create-external-bootstrap-secret.sh) script and the value passed to the argument `--controlplane` matches the name of the Control Plane specified by the Helm chart, then the sub-section `bootstrapSecret` is not required because all default values will identify the bootstrap secret created by the script. More specifically, if an external kind cluster was created with the command `kind create cluster --name its1` and the `create-external-bootstrap-secret.sh --controlplane its1 --verbose` command was used to create the bootstrap secret, then it would be enough to inform the Helm chart with `--set-json='ITSes=[{"name":"its1","type":"external"}]'`. |
Contributor
|
Thank you for your contribution! Your PR has been merged. Check out what's new:
Stay connected: Slack #kubestellar-dev | Multi-Cluster Survey |
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
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.
Fixes #6168
Changes
Replaced all unresolved MkDocs template variables (
{{ config.ks_latest_release }}and{{ config.ks_latest_regular_release }}) with the actual version number0.30.0fromsrc/config/versions.ts.Files Modified
docs/content/kubestellar/get-started.md(5 occurrences)docs/content/kubestellar/binding.md(2 occurrences)docs/content/kubestellar/acquire-hosting-cluster.md(1 occurrence)docs/content/kubestellar/control.md(1 occurrence)docs/content/kubestellar/core-chart.md(2 occurrences)docs/content/kubestellar/start-from-ocm.md(2 occurrences)Total: 13 broken links fixed
Root Cause
These template variables work in MkDocs but are not processed in the Next.js build pipeline. Fixed by replacing with hardcoded version numbers.