docs: full copy-edit of CronWorkflows page #13292
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
- simplify a bunch, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - use active voice and present tense where possible, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense) - avoid Latin phrases, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-latin-phrases) - avoid leveling words, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-words-that-assume-a-specific-level-of-understanding) - prefer 1 sentence per line of markdown, per [style guide](https://argo-workflows.readthedocs.io/en/release-3.5/doc-changes/) - reformat the table of options so that it is readable in markdown - don't center the columns, left-align them - there's no reason to center them and this is inconsistent with the rest of the docs; unnecessarily complicated - note that later rows did not do this either - put the ending `|` one space after the row - the very long amount of whitespace would wrap around every row even in my wide screen monitors, despite that only a few options have long descriptions - add a link to IANA and DST similar to the existing cron link - specify that the same cron library is used by k8s `CronJobs` Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
agilgur5
added
area/docs
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
|
LGTM We still need to add documentation related to the |
|
Oh, I forgot about that. Also all my other review comments 😅 |
Will you work on that or want me to? just to avoid duplicating efforts |
|
If you could that'd be great. I have a bit too much on my plate as-is right now. |
Joibel
approved these changes
Jul 11, 2024
|
Agreed; we could have a "Best Practices" section at the bottom of this page (and others) |
agilgur5
added a commit
that referenced
this pull request
Jul 11, 2024
- fixed merge conflict within the table; removed `stopStrategy` for `release-3.5` Signed-off-by: Anton Gilgur <agilgur5@gmail.com> (cherry picked from commit 5aac5a8)
agilgur5
added a commit
that referenced
this pull request
Jul 11, 2024
- fixed merge conflict within the table; removed `stopStrategy` for `release-3.4` Signed-off-by: Anton Gilgur <agilgur5@gmail.com> (cherry picked from commit 5aac5a8)
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.
Motivation
Made a lot of modifications to this page during reviews of #13280 and #12696, so wanted to make the rest match the current style guides.
Also aligns with all my other full copy-edits of docs pages
Modifications
follow the style guides
reformat the table of options so that it is readable in markdown
|one space after the rowCronJobsVerification
make docspasses