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

Rewrite Getting Started to have 3 sections: K8s, Compose, Local Services #3805

Open
godber opened this issue Oct 23, 2024 · 1 comment
Open
Assignees

Comments

@godber
Copy link
Member

godber commented Oct 23, 2024

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

  • Getting Started in ...
  • KIND (Local Kubernetes)
  • Docker Compose
  • Local Services - This is the current documentation.

Think about this from the perspective of a user who wants to learn what on earth Teraslice does.

Lets discuss the exact details.

@godber
Copy link
Member Author

godber commented Oct 23, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants