-
Notifications
You must be signed in to change notification settings - Fork 480
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
Update and standardise admonitions #3066
Conversation
Hi @craigbox. 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 Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @craigbox! Despite the number of nits I left here, I definitely appreciate you diving in here -- many thanks!
I think your general take on using "since vX.Y.Z" instead of "in vX.Y.Z+" is good. I stopped adding suggested changes when I realized how many there are (🤦♂️) but I would love to see that change throughout all this stuff.
Also, we're apparently inconsistent about whether to link to the "for more info on release channels" bit – I think it would be good to make things consistent there too? Open to other suggestions though.
And again, thanks! Much-needed work here. 🙂
It looked like the standard (the stable? 😳) was to use "in vX+" in headings and "since vX" in body. Happy to standardise on "since" throughout if you prefer. |
Thanks @craigbox! No strong preference between "since" and "in Vx+" as long as we're being consistent across the admonitions. Also "standard" was ironically the word we used to reserve "stable" for a future more stable channel, and then "standard" effectively became the "stable" channel 🙃. /ok-to-test |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: craigbox, robscott 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 |
Done!
Also done! |
@@ -54,10 +54,10 @@ resources), in the same cluster. | |||
|
|||
## Gateway API for Service Mesh (the [GAMMA initiative](/mesh/gamma)) <a name="for-service-mesh"></a> | |||
|
|||
??? example "Standard in v1.2.0+" | |||
??? success "Standard Channel since v1.2.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure who introduced v1.2 here, but it wasn't you. I'll file a follow up PR to fix this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agg, I fixed at least one of these. Sorry to miss this one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @craigbox!
/lgtm
* Update and standardise admonitions * how you like that, search and replace?
* Update and standardise admonitions * how you like that, search and replace?
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Update admonitions to correctly reflect API changes in 1.2.0, as well as fixing a bunch that were never updated in the past.
Standardize markup and wording throughout.
Does this PR introduce a user-facing change?: