arlon icon indicating copy to clipboard operation
arlon copied to clipboard

[Req] Working examples for commands

Open Rohitrajak1807 opened this issue 2 years ago • 8 comments

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 avatar Sep 08 '22 06:09 Rohitrajak1807

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 avatar Sep 08 '22 06:09 ShaunakJoshi1407

@ShaunakJoshi1407 we would need more detailed exsmples. Take a look at https://github.com/platform9/appctl/blob/62a82734cc269765472bbf44d134bfbe86d5a90b/cmd/appDeploy.go#L18

Rohitrajak1807 avatar Sep 08 '22 06:09 Rohitrajak1807

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

ShaunakJoshi1407 avatar Sep 08 '22 06:09 ShaunakJoshi1407

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 avatar Sep 08 '22 06:09 Rohitrajak1807

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

ShaunakJoshi1407 avatar Sep 08 '22 06:09 ShaunakJoshi1407

Hey team! Please add your planning poker estimate with Zenhub @bcle @jayanth-tjvrr @Rohitrajak1807 @ShaunakJoshi1407

cruizen avatar Jan 12 '23 16:01 cruizen

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

cruizen avatar Jan 12 '23 16:01 cruizen

These examples should be as simple as copy paste and go

Rohitrajak1807 avatar Jan 12 '23 16:01 Rohitrajak1807