Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 book: update refs to older books #6192

Merged
merged 1 commit into from
Feb 23, 2022

Conversation

sbueringer
Copy link
Member

@sbueringer sbueringer commented Feb 23, 2022

Signed-off-by: Stefan Büringer [email protected]

What this PR does / why we need it:
As discussed in #6017 (comment) we now have books of all versions available. This PR updates the references to those books accordingly

Ref:

  • main.cluster-api.sigs.k8s.io => main
  • cluster-api.sigs.k8s.io => release-1-1
  • release-1-1.cluster-api.sigs.k8s.io => release-1-1
  • release-1-0.cluster-api.sigs.k8s.io => release-1-0
  • release-0-4.cluster-api.sigs.k8s.io => release-0-4
  • release-0-3.cluster-api.sigs.k8s.io => release-0.3

This PR only changes the book on main and is not meant to be backported as is to older branches. But I would also open PRs for release-1.1 and release-1.0 to update the books similarly.

P.S. I add a corresponding task to the housekeeping issue which is ~: When we setup the book for the next version we should update the note accordingly.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 23, 2022
<h1>Documentation of older ClusterAPI versions</h1>

This book documents ClusterAPI v1.2. For older Cluster API versions please see the corresponding documentation:
* [release-1-1.cluster-api.sigs.k8s.io](https://release-1-1.cluster-api.sigs.k8s.io)
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure if we should add a link to the main book as well, to make it very obvious.

Copy link
Member

Choose a reason for hiding this comment

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

I'm +1 to add it, so when this will be server at https://cluster-api.sigs.k8s.io/, user know how to jump to the latest and greatest

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, yup I expect that I will need that myself as I'm still used to that whatever we just merged is already available on https://cluster-api.sigs.k8s.io/

Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 23, 2022
Signed-off-by: Stefan Büringer [email protected]
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 23, 2022
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 23, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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

The pull request process is described here

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 23, 2022
@sbueringer
Copy link
Member Author

Re-triggered the md linkchecker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants