-
-
Notifications
You must be signed in to change notification settings - Fork 13
Include all our products in the Getting Started guide #160
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
Comments
If I understand this correctly, we almost have this in place. As part of this epic (#237) We created getting started guides for all products with minimal usage examples. I'd imagine that we could just link to all of them from the common getting started page: https://docs.stackable.tech/home/getting_started.html and this ticket might be done already? Alternatively I'd like to have multiple (~3) getting started "tracks" for the different ecosystems, which could then cover all products together. That would then be larger tutorials, like the getting started guide we have now, or the data pipeline tutorial we have. I wouldn't try to come up with a usecase where all products are involved. |
Thanks for bringing this up again! What do you prefer? |
I'd like to move the tutorial-style part of the guide into a tutorial, I'd like to keep the part about installing k8s and move it into a dedicated page to link to from other places, and then I'd like to have a list of all the getting started guides for the products. Then we could direct the user to the appropriate places: getting started with a product, or with a sample use-case tutorial. (sorry for replying so late) |
Okay, do you want to do this in this ticket or is there another one already? |
okay, here is the list of all getting started guides: https://docs.stackable.tech/home/nightly/tutorials/ I consider this done now. |
As a user of the platform I'd like to have one simple tutorial to follow to install the whole platform and have all tools from the platform running.
I want our documentation to follow this practice: https://diataxis.fr/
This basically means all documentation must fall in one of these categories: Tutorial, How-to guide, Reference, Explanation.
This ticket is about a Tutorial.
This is done when a user
Edit TODO: Convert to Epic
The text was updated successfully, but these errors were encountered: