Skip to content

docs(cli): add example field to argo cluster-template create. Fixes #11898#12101

Merged
terrytangyuan merged 17 commits intoargoproj:masterfrom
shubhamch71:create-template-command-examples--help-output
Oct 31, 2023
Merged

docs(cli): add example field to argo cluster-template create. Fixes #11898#12101
terrytangyuan merged 17 commits intoargoproj:masterfrom
shubhamch71:create-template-command-examples--help-output

Conversation

@shubhamch71
Copy link
Contributor

Fixes #11898

Motivation

Changes to support more detailed information when the user runs the argo cluster-template create command

Modifications

Added examples for some common usages of argo cluster-template create command

Verification

RUN argo cluster-template create --help

…ixes argoproj#11898

Signed-off-by: shubhamch71 <shubhamchau71@gmail.com>
Signed-off-by: shubhamch71 <shubhamchau71@gmail.com>
…goproj#11898

Signed-off-by: shubhamch71 <shubhamchau71@gmail.com>
@shubhamch71
Copy link
Contributor Author

@agilgur5 I ran the command make pre-commit -B before creating pr but , then also it is failing the codegen test. Can you please guide me if possible ?

@agilgur5
Copy link

The diff in CI is showing that the indentation changed from spaces to tabs. Not sure if your editor may have accidentally converted it to spaces?

Copy link

@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 writing up some examples. I left some comments in-line.

shubhamch71 and others added 5 commits October 30, 2023 01:27
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>
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>
Signed-off-by: shubhamch71 <shubhamchau71@gmail.com>
@shubhamch71 shubhamch71 force-pushed the create-template-command-examples--help-output branch from bf53de8 to a4fdd98 Compare October 29, 2023 22:58
Signed-off-by: shubhamch71 <shubhamchau71@gmail.com>
Copy link

@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.

codegen is still failing due to indentation differences. lint is now also failing due to incorrect indentation.

see in-line comments below:

shubhamch71 and others added 5 commits October 30, 2023 05:28
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>
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>
Signed-off-by: Shubham <83663663+shubhamch71@users.noreply.github.com>
shubhamch71 and others added 3 commits October 30, 2023 06:26
…roj#11898

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>
…create command. Fixes argoproj#11898

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

@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, lint and codegen now pass! thanks for working through the CI issues 🙂

@shubhamch71
Copy link
Contributor Author

LGTM, lint and codegen now pass! thanks for working through the CI issues 🙂

@agilgur5 I am grateful for your guidance and support in overcoming these challenges. Having gained a better understanding of this , I am now going to contribute to other commands of issue #11898. It's all thanks to you!!! 🙂

@shubhamch71 shubhamch71 marked this pull request as ready for review October 30, 2023 02:40
@terrytangyuan terrytangyuan merged commit ae67772 into argoproj:master Oct 31, 2023
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add examples to commands' --help output

3 participants