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(install): use material admonition instead of unicode caution #12561

Merged
merged 1 commit into from Feb 5, 2024

Conversation

agilgur5
Copy link
Member

Motivation

  • use admonitions that come with the material theme instead of a unicode caution sign
    • consistent with the design of the docs

Modifications

  • replace unicode caution signs with admonitions

  • be more specific in the notes as well

    • using a remote base is not inherently "dangerous" as the previous sentence said without elaboration
      • instead specify that you should use a full hash when using a remote base
      • and add a link to Kustomize's remote base docs
    • similarly in the second note, specify what "tip" means
      • and specify what you should do instead of using latest

Verification

  1. mkdocs build passes
  2. Looks as expected:
    • Before:
      Screenshot 2024-01-21 at 10 20 47 PM

    • After:
      Screenshot 2024-01-21 at 10 22 31 PM

- use [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) that come with the material theme
  - instead of a unicode caution sign

- be more specific in the notes as well
  - using a remote base is not inherently "dangerous" as the previous sentence said without elaboration
    - instead specify that you should use a full hash when using a remote base
    - and add a link to Kustomize's remote base docs
  - similarly in the second note, specify what "tip" means
    - and specify what you should do instead of using `latest`

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Jan 22, 2024
@terrytangyuan terrytangyuan merged commit 0e90cc5 into argoproj:main Feb 5, 2024
15 checks passed
@agilgur5 agilgur5 deleted the docs-install-use-admonition branch February 5, 2024 18:41
agilgur5 added a commit that referenced this pull request Apr 9, 2024
…2561)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
(cherry picked from commit 0e90cc5)
@agilgur5
Copy link
Member Author

agilgur5 commented Apr 9, 2024

Backported cleanly to release-3.5 as 0d4bb58

@agilgur5 agilgur5 added this to the v3.5.x patches milestone Apr 9, 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.

None yet

3 participants