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

[Req] Working examples for commands #203

Open
Rohitrajak1807 opened this issue Sep 8, 2022 · 8 comments
Open

[Req] Working examples for commands #203

Rohitrajak1807 opened this issue Sep 8, 2022 · 8 comments
Assignees
Labels
good first issue Good for newcomers Needs Review For all new issues that are unplanned, have no milestone or project. Requirement User Guide Docs and Tutorials
Milestone

Comments

@Rohitrajak1807
Copy link
Member

Rohitrajak1807 commented Sep 8, 2022

Adding an Example property to each cobra.Command to provide the end user with working example can simplify their understanding of Arlon

Aha! Link: https://pf9.aha.io/features/ARLON-399

@Rohitrajak1807 Rohitrajak1807 added Needs Review For all new issues that are unplanned, have no milestone or project. Requirement labels Sep 8, 2022
@ShaunakJoshi1407
Copy link
Member

I am adding some examples as a part of this PR: #202
Do let me know if some additional examples can be added

@Rohitrajak1807
Copy link
Member Author

Rohitrajak1807 commented Sep 8, 2022

@ShaunakJoshi1407
Copy link
Member

Yep that can be added for commands like arlon cluster, arlon profile and arlon bundle commands

@Rohitrajak1807
Copy link
Member Author

Yep that can be added for commands like arlon cluster, arlon profile and arlon bundle commands

It'd be better to do it separately with ready to use detailed examples as it's own PR, I see that #202 also adds install and verify commands too.

@Rohitrajak1807 Rohitrajak1807 added the User Guide Docs and Tutorials label Sep 8, 2022
@ShaunakJoshi1407
Copy link
Member

ShaunakJoshi1407 commented Sep 8, 2022

Yes I was about to change that PR to just make changes in install and verify for now. A separate PR can be raised for addin examples

@Rohitrajak1807 Rohitrajak1807 added the good first issue Good for newcomers label Sep 16, 2022
@cruizen
Copy link
Member

cruizen commented Jan 12, 2023

@cruizen
Copy link
Member

cruizen commented Jan 12, 2023

@ShaunakJoshi1407 , @Rohitrajak1807 since you have worked on this and related docs earlier, please add some comments on the scope, what examples exist vs what don't - and please assign yourself if you plan to take it up.

@Rohitrajak1807 Rohitrajak1807 self-assigned this Jan 12, 2023
@Rohitrajak1807
Copy link
Member Author

These examples should be as simple as copy paste and go

@cre8minus1 cre8minus1 added this to the Not Planned milestone Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers Needs Review For all new issues that are unplanned, have no milestone or project. Requirement User Guide Docs and Tutorials
Projects
None yet
Development

No branches or pull requests

4 participants