godber
commented
1 month ago From a user perspective:
Teraslice is written in Node.js and has been tested on Linux and Mac OS X.
This is about the least useful information. People don't want to worry about those details ... thats a list of stuff to worry about. A getting started is meant to SHOW end users what a thing does. Minimize the impact of the pain they have to go through to use it.
So start by very briefly telling them what they're going to get, maybe we need to stream NOAA data in to make it interesting. Then explain they need Docker and Kubectl ... assume MacOS to begin with. What three commands does someone have to type to get Teraslice up and running?
This should be re-written to quickly get the user up and running first in Kubernetes. Make it fast, ten minutes to get things going ...
https://terascope.github.io/teraslice/docs/getting-started.html
There should be three overall sections in this (maybe separate pages):
Think about this from the perspective of a user who wants to learn what on earth Teraslice does.
Lets discuss the exact details.