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(cli): correct headings in argo command's Long description #11980

Merged
merged 3 commits into from
Nov 20, 2023

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Oct 10, 2023

Motivation

  • these were H1s before, and there can only be 1 H1 per page
    • they also should be H4s, because these are under the "Synopsis", which is an H3
      • this fixes some very wacky formatting in the docs as well as HTML semantic errors

Modifications

  • h1 -> h4 in argo root command's Long description

Verification

Before:
Screenshot 2023-10-10 at 2 39 08 PM --before

After:
Screenshot 2023-10-10 at 2 40 35 PM --after

- these were H1s before, and there can only be 1 H1 per page
  - they also _should_ be H4s, because these are under the "Synopsis", which is an H3
    - this fixes some very wacky formatting in the docs as well as some HTML semantic errors

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs labels Oct 10, 2023
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be docs instead of fix?

@agilgur5
Copy link
Member Author

agilgur5 commented Oct 11, 2023

It is a CLI change, though in this case it impacts the generated docs more than the CLI help text itself. I labeled the PR as both

Speaking of generated docs, I realized I forgot codegen here. I felt like something was missing or I ran the wrong command. Sick 😷 brain misses some details 😅, this is why I'm holding off on doing some complex code reviews right now

@terrytangyuan
Copy link
Member

Generated docs are docs change.

@agilgur5
Copy link
Member Author

agilgur5 commented Oct 11, 2023

Sure, but it also changes the source code / metadata of the CLI. nbd either way to be fair, but we're not currently cherry-picking docs PRs, which we will need to do for versioned docs. so we'll need some way to decipher docs PRs that are for new features vs docs PRs for existing features (most will fall into the latter, I imagine). semantically, it's generally quick to tell from a given PR, but there's no way to do that automatically right now unless we differentiate in some way

- woops, I missed this, despite primarily looking to change that
  - think I forgot that `make codegen` also impacts the docs, so `make docs` doesn't quite cover everything

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5
Copy link
Member Author

fixed codegen

Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
@agilgur5
Copy link
Member Author

Merged master to get new status checks / actions from #12006 to run

@terrytangyuan terrytangyuan changed the title fix(cli): correct headings in argo command's Long description docs(cli): correct headings in argo command's Long description Nov 20, 2023
@terrytangyuan terrytangyuan enabled auto-merge (squash) November 20, 2023 20:10
@terrytangyuan terrytangyuan merged commit feaed7a into argoproj:master Nov 20, 2023
28 checks passed
@agilgur5 agilgur5 deleted the fix-cli-argo-headings branch November 20, 2023 20:11
shuangkun pushed a commit to shuangkun/argo-workflows that referenced this pull request Nov 21, 2023
…rgoproj#11980)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
agilgur5 added a commit that referenced this pull request May 4, 2024
…11980)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
(cherry picked from commit feaed7a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants