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

Update and standardise admonitions #3066

Merged
merged 2 commits into from
May 10, 2024

Conversation

craigbox
Copy link
Contributor

@craigbox craigbox commented May 9, 2024

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?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 9, 2024
@k8s-ci-robot
Copy link
Contributor

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 /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.

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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 9, 2024
site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/mesh/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/mesh/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kflynn kflynn left a 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. 🙂

@craigbox
Copy link
Contributor Author

craigbox commented May 9, 2024

I think your general take on using "since vX.Y.Z" instead of "in vX.Y.Z+" is good.

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.

@robscott
Copy link
Member

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
/approve

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 10, 2024
@k8s-ci-robot
Copy link
Contributor

[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 /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 May 10, 2024
@k8s-ci-robot k8s-ci-robot removed the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 10, 2024
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 10, 2024
@craigbox
Copy link
Contributor Author

I would love to see that change throughout all this stuff.

Done!

"for more info on release channels" bit – I think it would be good to make things consistent there too? Open to other suggestions though.

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"
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 not sure who introduced v1.2 here, but it wasn't you. I'll file a follow up PR to fix this.

Copy link
Contributor Author

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.

Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks @craigbox!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 10, 2024
@k8s-ci-robot k8s-ci-robot merged commit 67c61f6 into kubernetes-sigs:main May 10, 2024
8 checks passed
BobyMCbobs pushed a commit to BobyMCbobs/kubernetes-sigs-gateway-api that referenced this pull request Jul 10, 2024
* Update and standardise admonitions

* how you like that, search and replace?
BobyMCbobs pushed a commit to BobyMCbobs/kubernetes-sigs-gateway-api that referenced this pull request Jul 22, 2024
* Update and standardise admonitions

* how you like that, search and replace?
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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants