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

📖 Add breaking changes section to introduction.md #8165

Merged

Conversation

joekr
Copy link
Member

@joekr joekr commented Feb 23, 2023

What this PR does / why we need it:
We want a way to call out some upcoming breaking changes for new versions. This adds a note style callout in the
ClusterAPI documentation versions section.

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 23, 2023
@joekr
Copy link
Member Author

joekr commented Feb 23, 2023

local book build preview

image

docs/book/src/introduction.md Outdated Show resolved Hide resolved
docs/book/src/introduction.md Outdated Show resolved Hide resolved
docs/book/src/introduction.md Outdated Show resolved Hide resolved
docs/book/src/introduction.md Outdated Show resolved Hide resolved
@joekr joekr force-pushed the add-breaking-changes-to-book branch from be161fa to af5782b Compare February 23, 2023 16:39
@joekr joekr requested review from oscr and removed request for richardcase and JoelSpeed February 23, 2023 16:39
Copy link
Contributor

@oscr oscr left a comment

Choose a reason for hiding this comment

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

Great work! Thank you for adding this

/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, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 96f8a0f06d4363eb68e0dccc7fbfe2e7df3842e0

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.

Good idea!

/lgtm

Copy link
Member

@richardcase richardcase left a comment

Choose a reason for hiding this comment

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

I like this idea 👍

docs/book/src/introduction.md Outdated Show resolved Hide resolved
@joekr joekr force-pushed the add-breaking-changes-to-book branch from af5782b to 75b3255 Compare February 23, 2023 20:17
@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, 2023
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 23, 2023
@joekr joekr force-pushed the add-breaking-changes-to-book branch from 75b3255 to 4cf2f9b Compare February 23, 2023 20:19
We want a way to call out some upcoming breaking changes for new
versions. This adds a note style callout in the
`ClusterAPI documentation versions` section.
@joekr joekr force-pushed the add-breaking-changes-to-book branch from 4cf2f9b to 0bf4457 Compare February 23, 2023 20:21
@richardcase
Copy link
Member

/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, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 43cc41f3b9674087e5b4c259cbb6fd2cded511b1

@sbueringer
Copy link
Member

/lgtm

@joekr Just fyi, preview is also available here: https://deploy-preview-8165--kubernetes-sigs-cluster-api.netlify.app/
(link can be found in the "deploy/netlify" check)

@oscr
Copy link
Contributor

oscr commented Feb 24, 2023

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: oscr

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 24, 2023
@k8s-ci-robot k8s-ci-robot merged commit c5f4e0f into kubernetes-sigs:main Feb 24, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.4 milestone Feb 24, 2023
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.

7 participants