docs: minor copy-edits to releases page #13134
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- did a full style guide audit of this page too, similar to my previous PRs, but there wasn't _too_ much to change here - put italics around the fact that Argo doesn't use SemVer -- just to be _more_ explicit - remove duplicated note about breaking changes being listed in the upgrading guide - the next section says the same thing - simplify release cycle section, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - replace use of jargon such as "shipped", per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-jargon-and-idioms) - use more consistent language as well - introduce RCs and capitalize the terms, then use the term RC - use "version" and "release" consistently - prefer 1 sentence per line of markdown, per [style guide](https://argo-workflows.readthedocs.io/en/release-3.5/doc-changes/) - fix some minor grammar issues (missing articles, extra comma, etc) Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
juliev0
approved these changes
Jun 2, 2024
agilgur5
added a commit
that referenced
this pull request
Jun 14, 2024
Signed-off-by: Anton Gilgur <agilgur5@gmail.com> (cherry picked from commit 85c8832)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to #13132 and #11934
Motivation
Modifications
remove duplicated note about breaking changes being listed in the upgrading guide
simplify release cycle section, per k8s style guide
other minor style changes:
put italics around the fact that Argo doesn't use SemVer -- just to be more explicit
replace use of jargon such as "shipped", per k8s style guide
use more consistent language as well
prefer 1 sentence per line of markdown, per style guide
fix some minor grammar issues (missing articles, extra comma, etc)
Verification
make docspasses