docs(cli): clarify stop v. terminate with Long descriptions
#11626
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- this is one of the most frequently asked questions by users and so could definitely use some clarification - add a `Long` description to the CLI commands that details how `stop` and `terminate` work in more detail - via `make codegen`, this resulted in a `### Synopsis` section in the generated docs as well, which is also helpful Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
|
Huh, lint timed out. Haven't seen that happen before. Will need to retry that but may need to bump the timeout. Seems like a one-off right now though |
5 tasks
caelan-io
approved these changes
Aug 24, 2023
isubasinghe
approved these changes
Aug 24, 2023
terrytangyuan
approved these changes
Aug 24, 2023
terrytangyuan
changed the title
stop v. terminate with Long descriptionsstop v. terminate with Long descriptions
|
Please fix lint |
Per my comment above, it timed out and needs a retry |
|
Looks like this is good to merge now, CI is green after retry |
terrytangyuan
pushed a commit
that referenced
this pull request
Sep 5, 2023
…1626) Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
dpadhiar
pushed a commit
to dpadhiar/argo-workflows
that referenced
this pull request
May 9, 2024
…goproj#11626) Signed-off-by: Anton Gilgur <agilgur5@gmail.com> Signed-off-by: Dillen Padhiar <dillen_padhiar@intuit.com>
agilgur5
added
area/docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Similar to #11625, this is another one of the most frequently asked questions by users and so could definitely use some clarification
Modifications
retryandresubmit#11625, add aLongdescription to the CLI commands that details howstopandterminatework in more detailmake codegen, this resulted in a### Synopsissection in the generated docs as well, which is also helpfulDescriptions loosely follow the official issue response in #4454 (comment).
This is effectively a follow-up to #4653
Verification
make codegenpassesNotes for Reviewers
I wrote this as a "fix" commit so that it can be added as a patch to the CLI (and make it into any cherry-picks), but could make it a "docs" commit instead.
Feel free to add more modifications to the long descriptions!
Future Work
I'd like to add these descriptions to the API docs as well, but that seems to be a larger effort as the API docs have no descriptions right now 😕 I'm also not sure where codegen tries to pull the descriptions from, as there are GoDoc descriptions, but perhaps not in the right places?