Open prakashmishra1598 opened 4 years ago
This is an important aspect to document.
I really love the way Google Cloud documents its actions. It uses table to differentiate between the web UI and cli. Here's an example: https://cloud.google.com/compute/docs/instances/create-start-instance
That is exactly the type of documentation that I would love to see. Having the choice between the tools and having strong documentation around both would be great :)
The problem faced currently?
space-cli
currently doesn't have documentation around using it to accomplish tasks that it can perform. If we really want a strong CLI tool that can accomplish the tasks that the dashboard can, it would be nice to have some documentation around it. A lot of developers prefer using the cli over web UIs as it just makes them faster. Also havingspace-cli
alternatives to common actions performed via the web UI would be great.How can we solve it?
We could put up some documentation for
space-cli
along with having examplespace-cli
commands to accomplish tasks that are performed by the web UI thereby providing users the choice to switch to cli to do the same operations.