docs: point the install guide at the current release - #396
docs: point the install guide at the current release#396tejassinghbhati wants to merge 4 commits into
Conversation
✅ Deploy Preview for node-readiness-controller ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
ef2e2d2 to
5c934ff
Compare
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>
5c934ff to
cd1e42b
Compare
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>
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > `install-full.yaml` is only published from `v0.2.0` onwards. Older releases ship `crds.yaml` and `install.yaml` only. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Done, dropped the note in the latest commit.
Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>
|
New changes are detected. LGTM label has been removed. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: tejassinghbhati 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 |
Description
The install guide pinned
VERSION=v0.1.1from January while latest isv0.4.1, so anyone following it installed a build three releases behind.docs/book/src/releases.mdin the same book correctly listsv0.4.1, so the two pages disagreed.It also broke the full install path. The guide offers
install-full.yaml, butv0.1.1never shipped that artifact. Following the guide as written and picking the full option returns a 404. Checking the published assets,install-full.yamlfirst appears inv0.2.0: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.mdbut never mentioned this page, which is why the pin sat untouched across three releases. I considered resolving the tag dynamically withcurlandjqinstead, but that puts ajqdependency on the primary install path, and a checklist line matches how the project already handlesreleases.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:
and confirmed the
v0.2.0claim against the published release assets rather than assuming it.Checklist
make testpassesmake lintpassesDoes this PR introduce a user-facing change?