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: Add an example field to argo archive list command. Fixes #11898 #12110

Conversation

shubhamch71
Copy link
Contributor

Fixes #11898

Motivation

Changes to support more detailed information when the user runs the argo archive list command

Modifications

Added examples for some common usages of argo archive list command

Verification

RUN argo archive list --help

Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
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.

Codegen failed

Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
@shubhamch71
Copy link
Contributor Author

@agilgur5 Could you help point out where and why the codegen test is failing? I used the same spacing format as before for the other command, but it is still failing!!

@agilgur5 agilgur5 added area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs labels Nov 2, 2023
cmd/argo/commands/archive/list.go Outdated Show resolved Hide resolved
cmd/argo/commands/archive/list.go Outdated Show resolved Hide resolved
# List Archived Workflows with a specific chunk size:
argo archive list --chunk-size <chunk_size>

# List Archived Workflows with the specified label (used to filter archived workflows):
Copy link
Member

Choose a reason for hiding this comment

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

this doesn't match the modified description (you changed it to label_s_, plural)

argo archive list --chunk-size <chunk_size>

# List Archived Workflows with the specified label (used to filter archived workflows):
argo archive list -l key1=value1,key2=value2
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
argo archive list -l key1=value1,key2=value2
argo archive list -l key1=value1,key2=value2

a new line at the end is generated

```
# List all Archived Workflows:
argo archive list

Copy link
Member

Choose a reason for hiding this comment

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

codegen is erroring on the whitespace here because you have trailing whitespace in the code, but not in the generated docs.

Can you get make codegen to run on its own (i.e. without running make pre-commit)?
that will make things a lot simpler than trying to manually match up to what codegen expects

shubhamch71 and others added 2 commits November 3, 2023 02:18
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
@agilgur5 agilgur5 added the problem/more information needed Not enough information has been provide to diagnose this issue. label Feb 5, 2024
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity and needs further changes. It will be closed if no further activity occurs.

@github-actions github-actions bot added the problem/stale This has not had a response in some time label Feb 20, 2024
Copy link
Contributor

github-actions bot commented Mar 5, 2024

This PR has been closed due to inactivity and lack of changes. If you would like to still work on this PR, please address the review comments and re-open.

@github-actions github-actions bot closed this Mar 5, 2024
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 problem/more information needed Not enough information has been provide to diagnose this issue. problem/stale This has not had a response in some time
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples to commands' --help output
3 participants