Skip to content

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

Closed
3 tasks
lfrancke opened this issue Mar 3, 2022 · 5 comments
Closed
3 tasks

Include all our products in the Getting Started guide #160

lfrancke opened this issue Mar 3, 2022 · 5 comments
Labels
release-note Denotes a PR that will be considered when it comes time to generate release notes.

Comments

@lfrancke
Copy link
Member

lfrancke commented Mar 3, 2022

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

  • can read a tutorial (it may be split over multiple pages but it should be a clear path "Next page" through the whole tutorial) with step-by-step directions on how to install every operator in our platform
  • and each operator section is accompanied with an example on how to deploy its product, this example can be minimal
  • and the written documentation follows the rough guidelines from this site: https://diataxis.fr/tutorials/

Edit TODO: Convert to Epic

@lfrancke lfrancke added release-note Denotes a PR that will be considered when it comes time to generate release notes. type/documentation labels Mar 3, 2022
@fhennig
Copy link
Contributor

fhennig commented Sep 1, 2022

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.

@lfrancke
Copy link
Member Author

lfrancke commented Sep 1, 2022

Thanks for bringing this up again!
Honestly: I'm fine with the Getting started guides as they are now.
If you like we can do as you suggested and include all of them in one big list. I'd also be fine with closing this ticket.

What do you prefer?

@fhennig
Copy link
Contributor

fhennig commented Sep 12, 2022

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)

@lfrancke
Copy link
Member Author

Okay, do you want to do this in this ticket or is there another one already?

@fhennig
Copy link
Contributor

fhennig commented Dec 12, 2023

okay, here is the list of all getting started guides: https://docs.stackable.tech/home/nightly/tutorials/
and here is the page about k8s getting started: https://docs.stackable.tech/home/nightly/kubernetes#local-installation

I consider this done now.

@fhennig fhennig closed this as completed Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note Denotes a PR that will be considered when it comes time to generate release notes.
Projects
None yet
Development

No branches or pull requests

2 participants