docs: copy-edit of Steps page #13157
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
- specify _which_ CLI command to use, and link to the reference for it as well - this has confused readers in the past, especially beginners - refer to the reader as "you", per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#address-the-reader-as-you) - simplify several sentences, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - prefer 1 sentence per line of markdown, per [style guide](https://argo-workflows.readthedocs.io/en/release-3.5/doc-changes/) Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
agilgur5
added
area/docs
Joibel
approved these changes
Jun 10, 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 55e2c7c)
agilgur5
added a commit
that referenced
this pull request
Jun 14, 2024
Signed-off-by: Anton Gilgur <agilgur5@gmail.com> (cherry picked from commit 55e2c7c)
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.
Fixes #9907 (comment), which I discovered after going through all old Giscus discussions per #13138 "Future Work"
Aligns with my other copy-edits of docs pages
Motivation
Simplify various sentences in the page, follow the style guide, and improve some confusing bits
Modifications
specify which CLI command to use, and link to the reference for it as well
refer to the reader as "you", per k8s style guide
simplify several sentences, per k8s style guide
prefer 1 sentence per line of markdown, per style guide
Verification
make docspasses