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.

Sign up for GitHub

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

Jump to bottom

docs: full copy-edit of CronWorkflows page #13292

Merged
merged 2 commits into from
Jul 11, 2024
Merged

docs: full copy-edit of CronWorkflows page #13292

merged 2 commits into from
Jul 11, 2024

Commits on Jul 2, 2024

  1. docs: full copy-edit of CronWorkflows page 

    - 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
    agilgur5 committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    bbca813 View commit details
    Browse the repository at this point in the history

  2. also left align the table headings 

    Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
    @agilgur5
    agilgur5 committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    21bfdc1 View commit details
    Browse the repository at this point in the history