arlon
arlon copied to clipboard
[Req] Working examples for commands
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
I am adding some examples as a part of this PR: https://github.com/arlonproj/arlon/pull/202 Do let me know if some additional examples can be added
@ShaunakJoshi1407 we would need more detailed exsmples. Take a look at https://github.com/platform9/appctl/blob/62a82734cc269765472bbf44d134bfbe86d5a90b/cmd/appDeploy.go#L18
Yep that can be added for commands like arlon cluster
, arlon profile
and arlon bundle
commands
Yep that can be added for commands like
arlon cluster
,arlon profile
andarlon 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.
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
Hey team! Please add your planning poker estimate with Zenhub @bcle @jayanth-tjvrr @Rohitrajak1807 @ShaunakJoshi1407
@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.
These examples should be as simple as copy paste and go