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 example field to argo archive command #11969

Closed
wants to merge 12 commits into from
Closed

docs(cli): add example field to argo archive command #11969

wants to merge 12 commits into from

Conversation

rum1887
Copy link

@rum1887 rum1887 commented Oct 9, 2023 •
edited
Loading

Fixes #11898 Added an example field to the archive command.

Motivation

Changes to support more detailed information when someone runs the archive Cobra command CLI

Verification

Run - argo archive

dependabot bot and others added 3 commits October 9, 2023 18:27
@dependabot @rum1887
chore(root): Add an example field to root.go(argoproj#11898)
808e578 
Signed-off-by: rum1887 <ramyapgk1887@gmail.com>
@rum1887
chore(root): Add an example field to root.go(argoproj#11898)
0327543 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root): DCO Fix(argoproj#11898)
33a9c53 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@agilgur5 agilgur5 mentioned this pull request Oct 9, 2023
Closed
agilgur5
agilgur5 requested changes Oct 9, 2023
View reviewed changes
yarn.lock Outdated Show resolved Hide resolved
go.sum Outdated Show resolved Hide resolved
rum1887 and others added 9 commits October 9, 2023 22:37
@rum1887
chore(root): Remove yarn.lock (argoproj#11898)
2e39cbb 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@dependabot @rum1887
chore(root): Add an example field to root.go(argoproj#11898)
b7f3fc5 
Signed-off-by: rum1887 <ramyapgk1887@gmail.com>
@rum1887
chore(root): Add an example field to root.go(argoproj#11898)
4cd5c5a 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root): DCO Fix(argoproj#11898)
a7a949f 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root): Remove yarn.lock (argoproj#11898)
a156602 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root): Merge branch 'master' of https://github.com/argoproj/arg…
40a95e6 
…o-workflows into archive/root.go (argoproj#11898)

Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root):Merge branch 'archive/root.go' of https://github.com/rum1…
ed387ae 
…887/argo-workflows into archive/root.go (argoproj#11898)

Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root): Corrected commands(argoproj#11898)
73c3212 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887
chore(root): Doc(argoproj#11898)
dc41158 
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@rum1887 rum1887 changed the title chore(root): Add an example field to root.go (#11898) chore(root): Add an example field to root.go Oct 10, 2023
agilgur5
agilgur5 requested changes Oct 11, 2023
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.

I think we'll want to rewrite this a bit or just not have any Long descriptions for root.go, as they don't have much value. See in-line comment below for one possible alternative. Otherwise, I would suggest to focus on other CLI commands whose examples would be more useful. I suggested some corrections to the list in #11898 (comment)

Also can you rename the title of this PR to something more clear? there are many files named root.go, so the current title is ambiguous.

I would suggest "docs(cli): Add an example to argo archive command"

cmd/argo/commands/archive/root.go
@@ -8,6 +8,22 @@ func NewArchiveCommand() *cobra.Command {
command := &cobra.Command{
Use: "archive",
Short: "manage the workflow archive",
Example: `
# List workflow archives:
Copy link
Member

Choose a reason for hiding this comment

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

you'll want to leave these unindented so that the generated markdown is unindented as well. Right now it would appear in the middle of the page

Copy link
Member

@agilgur5 agilgur5 Oct 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

the comments should ideally be the same as the ones in the individual commands. for instance, argo archive get has "get a workflow in the archive"

The Workflow Archive is also singular. There are "workflows in the archive" as the other commands have.

the commands should also be alphabetized to match the existing documentation

EDIT: see below comment

docs/cli/argo_archive.md
# Resubmit a workflow archive:
argo archive resubmit uid
# Retry a workflow archive:
argo archive retry uid
Copy link
Member

Choose a reason for hiding this comment

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

so this whole section is actually already repeated in the "See Also" section below. and in the sidebar in the docs as well. and in the CLI help output already.

so I don't think we should duplicate documentation here or in any root command really.

if we have anything here, I suppose we could have:

# Print this message
argo archive

# Otherwise, see subcommands below

@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Oct 11, 2023
@Allikooo Allikooo mentioned this pull request Oct 15, 2023
Closed
@agilgur5 agilgur5 added the problem/more information needed Not enough information has been provide to diagnose this issue. label Oct 20, 2023
@rum1887 rum1887 changed the title chore(root): Add an example field to root.go docs(cli): Add an example field to argo archive command Oct 20, 2023
@rum1887 rum1887 marked this pull request as draft November 29, 2023 05:44
@github-actions GitHub Actions
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 Jan 10, 2024
@github-actions GitHub Actions
Copy link
Contributor

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 Jan 25, 2024
@agilgur5 agilgur5 removed problem/stale This has not had a response in some time problem/more information needed Not enough information has been provide to diagnose this issue. labels Feb 8, 2024
@agilgur5 agilgur5 changed the title docs(cli): Add an example field to argo archive command docs(cli): add example field to argo archive command Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agilgur5 agilgur5 agilgur5 requested changes

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

Successfully merging this pull request may close these issues.

Add examples to commands' --help output
2 participants
@rum1887 @agilgur5