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: consistently use "> v{version} and after" #12581

Merged
merged 2 commits into from
Feb 17, 2024

Conversation

agilgur5
Copy link

@agilgur5 agilgur5 commented Jan 28, 2024

Motivation

  • some said "since" or "and above", while most said "and after"

    • "above" is a SemVer ref, whereas "after" is a date ref, so I think the latter is easier to interpret
      • nbd either way IMO, but be consistent
  • some just had the version without saying "and after" or similar

    • it is clearer to say "and after"
    • and most have it, so be consistent
  • some were missing the "v" in front of the version

    • again, be consistent
    • also the "v" does in fact matter for referencing tags (git or Docker / OCI)
  • two were in the wrong place, above the heading instead of below the heading

Modifications

  • consistently use "> v{version} and after" for version references in the docs
    • if they are for a new section, consistently place them immediately below the heading of the section
  • fix doubled > on an empty line

misc changes that were right next to the versions:

  • fix typo "The submit a" -> "Then submit a"
  • use a material warning admonition instead of a unicode caution sign, similar to docs(install): use material admonition instead of unicode caution #12561
  • link to official k8s docs regarding HA and multi-AZs
    • anti-affinity is not the only way to do this now, and topology spread constraints is perhaps a better / newer way of doing it
    • also, in general, prefer official docs links over blog posts

Verification

  1. Searched all references in the docs/ directory with "> "
  2. make docs passes

Anton Gilgur added 2 commits January 28, 2024 14:33
- some said "since" or "and above", while most said "and after"
  - "above" is a SemVer ref, whereas "after" is a date ref, so I think the latter is easier to interpret
    - nbd either way IMO, but be consistent

- some just had the version without saying "and after" or similar
  - it is clearer to say "and after"
  - and most have it, so be consistent

- some were missing the "v" in front of the version
  - again, be consistent (especially since the "v" does in fact matter for referencing tags)

- two were in the wrong place, above the heading instead of below the heading

- fix doubled `>` on an empty line

misc changes that were right next to the versions:
- fix typo "The submit a" -> "Then submit a"
- use a material warning box instead of a unicode caution sign
- link to official k8s docs regarding HA and multi-AZs
  - anti-affinity is not the only way to do this now, and topology spread constraints is perhaps a better / newer way of doing it
  - also, in general, prefer official docs links over blog posts

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Jan 28, 2024
@agilgur5 agilgur5 requested a review from jmeridth January 28, 2024 19:44
@juliev0 juliev0 merged commit d9caa75 into argoproj:main Feb 17, 2024
15 checks passed
@agilgur5 agilgur5 deleted the docs-fix-consistent-versions branch February 17, 2024 08:06
agilgur5 added a commit that referenced this pull request Feb 29, 2024
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added this to the v3.5.x patches milestone Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants