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

Generate VATZ CLI List in file #202

Closed
1 of 3 tasks
xellos00 opened this issue Jul 25, 2022 · 4 comments
Closed
1 of 3 tasks

Generate VATZ CLI List in file #202

xellos00 opened this issue Jul 25, 2022 · 4 comments
Assignees
Labels
area:svc Anything related to Vatz Service. type:documentation Anything related to Vatz documentation with *.md Vatz Project Name

Comments

@xellos00
Copy link
Member

xellos00 commented Jul 25, 2022


Checklist

  • New Feature for the Service/Plugin (Vatz)
  • Enhancement (Vatz)
  • others(etc. e.g, documentation, project policy management)

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. such as Ex. I'm always frustrated

I'm frustrated that I didn't started format document that record all detailed CLI commands and its options
and exec behaviors.


Describe the solution you'd like| Ex

A clear and concise description of what you want to happen

Create a internal documents in google sheet to categorize format and its commands


Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you have considered.


Additional context or comment

Add any other context or screenshots about the feature request here.

@xellos00 xellos00 added Vatz Project Name type:feature-development Any development regarding Vatz service/plugin, etc. labels Jul 25, 2022
@xellos00 xellos00 added area:svc Anything related to Vatz Service. type:documentation Anything related to Vatz documentation with *.md and removed type:feature-development Any development regarding Vatz service/plugin, etc. labels Jul 25, 2022
@xellos00 xellos00 added this to the Sprint 14 ( ~ 2022-08-03) milestone Jul 25, 2022
@rootwarp
Copy link
Member

@xellos00
Why do we need this document? is it for planning implementation or summarizing CLI command?

If you have intent for summarizing CLI command, I think cobra library could be document itself and command user can see help text by executing ~$ vatz --help.

@xellos00
Copy link
Member Author

xellos00 commented Jul 25, 2022

@xellos00 Why do we need this document? is it for planning implementation or summarizing CLI command?

If you have intent for summarizing CLI command, I think cobra library could be document itself and command user can see help text by executing ~$ vatz --help.

@rootwarp
This is internal only and not going to publish to public.
This is document that record all CLI behaviors clean and neat to sync each other prior to development with detail that shareable records of CLI commands.

Please, help yourself.
https://docs.google.com/spreadsheets/d/1WO3CB4XjAxqCkaCzP6fN4tlhDETAKKhe4Ddx3pNjtsw/edit?usp=sharing
Please, give me an other option that we can all share and put comment every details, instead above before development.

@rootwarp
Copy link
Member

rootwarp commented Jul 25, 2022

@xellos00 Why do we need this document? is it for planning implementation or summarizing CLI command?

If you have intent for summarizing CLI command, I think cobra library could be document itself and command user can see help text by executing ~$ vatz --help.

@rootwarp

This is internal only and not going to publish to public.

This is document that record all CLI behaviors clean and neat to sync each other prior to development with detail that shareable records of CLI commands.

Please, help yourself.

https://docs.google.com/spreadsheets/d/1WO3CB4XjAxqCkaCzP6fN4tlhDETAKKhe4Ddx3pNjtsw/edit?usp=sharing

Please, give me an other option that we can all share and put comment every details, instead above before development.

@xellos00 we can use code itself as a document for cli because we should set every details about cli on cobra and those will be used to help text which is created automatically.
So if we manage external doc for cli, that could be duplicated works.
but if you prefer to use google docs, i will use it.

@xellos00
Copy link
Member Author

I think we can close this issue due to

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:svc Anything related to Vatz Service. type:documentation Anything related to Vatz documentation with *.md Vatz Project Name
Projects
None yet
Development

No branches or pull requests

2 participants