Skip to content

docs: point the install guide at the current release - #396

Open
tejassinghbhati wants to merge 4 commits into
kubernetes-sigs:mainfrom
tejassinghbhati:docs/install-latest-release
Open

docs: point the install guide at the current release#396
tejassinghbhati wants to merge 4 commits into
kubernetes-sigs:mainfrom
tejassinghbhati:docs/install-latest-release

Conversation

@tejassinghbhati

Copy link
Copy Markdown
Contributor

Description

The install guide pinned VERSION=v0.1.1 from January while latest is v0.4.1, so anyone following it installed a build three releases behind. docs/book/src/releases.md in the same book correctly lists v0.4.1, so the two pages disagreed.

It also broke the full install path. The guide offers install-full.yaml, but v0.1.1 never shipped that artifact. Following the guide as written and picking the full option returns a 404. Checking the published assets, install-full.yaml first appears in v0.2.0:

v0.1.0 -> crds.yaml, install.yaml
v0.1.1 -> crds.yaml, install.yaml
v0.2.0 -> crds.yaml, install-full.yaml, install.yaml
v0.4.1 -> crds.yaml, install-full.yaml, install.yaml

So this bumps the pin, adds a note about which releases carry install-full.yaml, and adds the install guide to the release checklist.

The RELEASE.md line is the part that stops it happening again. Step 2 already told the shepherd to update releases.md but never mentioned this page, which is why the pin sat untouched across three releases. I considered resolving the tag dynamically with curl and jq instead, but that puts a jq dependency on the primary install path, and a checklist line matches how the project already handles releases.md.

Related Issue

Fixes #395

Type of Change

/kind documentation

Testing

Docs only. I verified every artifact the guide references actually resolves at the new pin:

crds.yaml        -> HTTP 200
install.yaml     -> HTTP 200
install-full.yaml -> HTTP 200

and confirmed the v0.2.0 claim against the published release assets rather than assuming it.

Checklist

  • make test passes
  • make lint passes

Does this PR introduce a user-facing change?

NONE

@kubernetes-prow kubernetes-prow Bot added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 12, 2026
@netlify

netlify Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deploy Preview for node-readiness-controller ready!

Name Link
🔨 Latest commit 57814ba
🔍 Latest deploy log https://app.netlify.com/projects/node-readiness-controller/deploys/6a888c9d661cfb0008e1481b
😎 Deploy Preview https://deploy-preview-396--node-readiness-controller.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kubernetes-prow kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 12, 2026
@kubernetes-prow

Copy link
Copy Markdown

Hi @tejassinghbhati. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

@kubernetes-prow kubernetes-prow Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 12, 2026
Comment thread docs/book/src/user-guide/installation.md Outdated
The guide pinned VERSION=v0.1.1 from January while latest is v0.4.1, so
anyone following it installed a build three releases behind. It also
offered install-full.yaml, which v0.1.1 never shipped, so choosing the
full install gave a 404. That artifact first appears in v0.2.0.

Bumps the pin, notes which releases carry install-full.yaml, and adds the
install guide to the release checklist in RELEASE.md. Step 2 already
called out releases.md but not this page, which is why the version was
never refreshed at release time.

Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>
Reviewer feedback, the existing comment already tells the reader to pick
a version, so the extra link was noise. Only the pin itself changes.

Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>
@tejassinghbhati
tejassinghbhati force-pushed the docs/install-latest-release branch from 5c934ff to cd1e42b Compare August 14, 2026 14:34
@tejassinghbhati

Copy link
Copy Markdown
Contributor Author

Rebased, no conflicts with the RELEASE.md changes from #402 and #407.

Still open question from earlier: keep the RELEASE.md line as the stopgap, or drop it and do the mdBook include once VERSION points at a real release?

Include the root VERSION file dynamically via mdBook's {{#include}} tag instead of maintaining a hardcoded version pin in the installation guide.

Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>

@ajaysundark ajaysundark left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/lgtm

```

> [!NOTE]
> `install-full.yaml` is only published from `v0.2.0` onwards. Older releases ship `crds.yaml` and `install.yaml` only.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This note can be removed as the only version that didn't ship this is v0.1.x and don't expect anyone to try with the first ever release.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done, dropped the note in the latest commit.

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 21, 2026
Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>
@kubernetes-prow kubernetes-prow Bot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 21, 2026
@kubernetes-prow

Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@kubernetes-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: tejassinghbhati
Once this PR has been reviewed and has the lgtm label, please ask for approval from ajaysundark. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Install guide pins v0.1.1, and that release has no install-full.yaml

2 participants