Currently the only help is the built in jcommander help, which can be invoked by typing easy-cass-lab without any parameters, or using -h. I think it would be helpful if we shipped a full manual. I'd like to use the output of that manual to generate the documentation, vs the current method of adding to the README.
I think this is a friendly syntax:
easy-cass-lab help <topic>
For example:
easy-cass-lab help provisioning
Would walk the user through the steps required to provision a new cluster, point them at the right external references like AWS instance types, and give them other related help topics they could read through.
Here's some high level ideas that come to mind, this is not an exclusive list:
Provisioning
Profiling. Listing the different profiling commands along with their intended effect.
Currently the only help is the built in jcommander help, which can be invoked by typing
easy-cass-labwithout any parameters, or using-h. I think it would be helpful if we shipped a full manual. I'd like to use the output of that manual to generate the documentation, vs the current method of adding to the README.I think this is a friendly syntax:
For example:
Would walk the user through the steps required to provision a new cluster, point them at the right external references like AWS instance types, and give them other related help topics they could read through.
Here's some high level ideas that come to mind, this is not an exclusive list: