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

docs: minor copy-edits to releases page #13134

Merged
merged 2 commits into from
Jun 2, 2024

Commits on Jun 2, 2024

  1. docs: minor copy-edits to releases page

    - 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>
    agilgur5 committed Jun 2, 2024
    Configuration menu
    Copy the full SHA
    4315d7d View commit details
    Browse the repository at this point in the history
  2. add backported to .spelling

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