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(cli): add examples for argo archive list with option explanations #13662

Merged
merged 15 commits into from
Sep 28, 2024
Merged

docs(cli): add examples for argo archive list with option explanations #13662

merged 15 commits into from
Sep 28, 2024
+29 −0

Conversation

leehosu
Copy link
Contributor

@leehosu leehosu commented Sep 25, 2024 •
edited
Loading

Fixes #11898

Motivation

Modify the argo archive list command for more information

Modifications

Added examples for the argo archive list command.

Verification

run argo archive list -h

@agilgur5 agilgur5 changed the title docs: Add examples for 'argo archive list' with option explanations docs(cli): add examples for argo archive list with option explanations Sep 25, 2024
@agilgur5 agilgur5 added area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs labels Sep 25, 2024
agilgur5
agilgur5 requested changes Sep 25, 2024
View reviewed changes
Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution. Please try to follow the issue description and it's recommendations closely, see in-line comments below

Verification

Added examples for the argo archive list command.

Verification means checking that these examples work and that the changes are tested / pass CI

v3 Outdated Show resolved Hide resolved
cmd/argo/commands/archive/list.go Show resolved Hide resolved
docs/cli/argo_archive_list.md Show resolved Hide resolved
@agilgur5 agilgur5 added the problem/more information needed Not enough information has been provide to diagnose this issue. label Sep 25, 2024
@agilgur5 agilgur5 removed the problem/more information needed Not enough information has been provide to diagnose this issue. label Sep 25, 2024
agilgur5
agilgur5 reviewed Sep 26, 2024
View reviewed changes
Copy link
Member

@agilgur5 agilgur5 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Some grammar and style changes below, plus more consistency suggestions.

Also you have not yet corrected your "Verification" section, per my previous comment. You should test the example commands you've listed and confirm they work.
Your other PR #13668 does not have a proper "Verification" section either

cmd/argo/commands/archive/list.go Outdated Show resolved Hide resolved
@agilgur5
Copy link
Member

agilgur5 commented Sep 28, 2024 •
edited
Loading

Codegen is failing correctly, you'll need to apply my previous suggestion to the generated CLI docs as well.

I did not mention that initially as that was intended as a learning opportunity for you to figure out on your own. As you've merged main twice for unrelated CI flakes, it seems you might have missed that.

agilgur5
agilgur5 approved these changes Sep 28, 2024
View reviewed changes
Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

LGTM now, thanks

@agilgur5 agilgur5 merged commit 5a2fa4e into argoproj:main Sep 28, 2024
27 checks passed
This was referenced Sep 28, 2024
Open
Closed
Merged
@leehosu leehosu deleted the docs/archive-command-example--help-ouput branch September 28, 2024 16:14
@leehosu leehosu mentioned this pull request Oct 1, 2024
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MasonM MasonM MasonM left review comments

@agilgur5 agilgur5 agilgur5 approved these changes

Assignees
No one assigned
Labels
area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add examples to commands' --help output
3 participants
@leehosu @agilgur5 @MasonM