-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Add examples to commands' --help output #11898
Comments
@tico24 Can you please assign this issue to me ? |
I think the idea is that users take each one and do a PR for each. It helps with people's Hacktober stats or something. |
Hey, I would like to integrate this into the help : https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/lint.go#L19 Should I use docker to setup the dev environment or how do I do it ? Thanks in advance!!! |
… description (argoproj#11898) Signed-off-by: nikzayn <nikhilvaidyar1997@gmail.com>
…#11898) Signed-off-by: nikzayn <nikhilvaidyar1997@gmail.com>
Signed-off-by: rum1887 <ramyapgk1887@gmail.com>
Signed-off-by: rum1887 <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: rum1887 <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
…o-workflows into archive/root.go (argoproj#11898) Signed-off-by: Ramya <ramyapgk1887@gmail.com>
…887/argo-workflows into archive/root.go (argoproj#11898) Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
Signed-off-by: Ramya <ramyapgk1887@gmail.com>
@tico24 could you make some modifications to this list? it is a bit naive right now. for example, similarly, most of the |
Signed-off-by: Krunal Parmar <parmarkrunal2007@gmail.com>
Signed-off-by: Krunal Parmar <parmarkrunal2007@gmail.com>
…ixes argoproj#11898 Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
I was hoping to take some files to start with, but already a lot of them have the example. Is the list in the description updated? It looks like the reality is different. Can we fix the list once? cc @agilgur5 as you created this one. 😉 |
I didn't create it, @tico24 did, that's why I can't edit it. Otherwise I would have done so already. There are definitely still many commands without examples, though see my above linked comment about ones that should be excluded. |
Thanks @agilgur5 for the response. Let me have a look at your comment on e again. 😊 |
Ok I'm now an Approver (as of today), so I now have permissions to edit other people's comments. I've fairly significantly edited the list and it should be up-to-date and improved now, as well as categorized |
@agilgur5 Is this going to be Hacktober issue this year? |
If there's anything leftover, sure. Note that hacktoberfest allows any valid contributions to repos, not just ones labeled that way. This one is just a particularly straightforward issue for newcomers. It looks like #13078 covered most of the rest, but is missing options here and there and will need iteration, so it depends on how far that goes |
Summary
The Argo CLI has a lot of commands for which we provide no example in the
--help
output.Motivation
Examples are awesome.
Proposal
For each item in this checklist, add an
Example
field. EDIT by agilgur5: See already-checked items for inspiration, use similar style & examples when possible, such asargo list
forargo archive list
, etc.In some cases, the code itself may provide sufficient information to write some examples. For other commands, you may have to read through the docs to find or create examples.
--- list has been updated & modified by agilgur5 ---
argo
commandsargo list
. Fixes #11898 #12076argo executor-plugin
commandsargo archive
commandsargo archive list
with option explanations #13662argo archive delete
#13675argo archive get
with option explanations #13668argo auth
commandsargo template
commandsargo cluster-template
commandsargo cluster-template create
. Fixes #11898 #12101argo cluster-template list
. Fixes #11898 #12106argo cron
commandsNote: I generated the list with this command which I liberated from @crenshaw-dev...
EDIT: list was further updated & modified by agilgur5
Message from the maintainers:
Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.
The text was updated successfully, but these errors were encountered: