search

spacecloud-io / space-cloud

Open source Firebase + Heroku to develop, scale and secure serverless apps on Kubernetes
https://space-cloud.io
Apache License 2.0
3.94k stars 222 forks source link

Documentation for space-cli #1154

Open prakashmishra1598 opened 4 years ago

prakashmishra1598 commented 4 years ago

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 having space-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 example space-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.

If you want this feature to be implemented, give it a thumbs up reaction, so that we can determine which features are important to you. 👍

YourTechBud commented 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

prakashmishra1598 commented 4 years ago

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 :)