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

Documentation: Add more extensive documentation on how to add catalogs to Trino instances #274

Closed
2 tasks done
soenkeliebau opened this issue Sep 6, 2022 · 6 comments
Closed
2 tasks done
Assignees

Comments

@soenkeliebau
Copy link
Member

soenkeliebau commented Sep 6, 2022

#263 implemented the TrinoCatalog feature which allows configuring catalogs for Trino via reusable objects (TrinoCatalog).

The documentation changes in that PR are fairly minimal and don't explain the fundamental concept of how these are linked and play together.

We should add a section to the documentation that explains:

  • what a TrinoCatalog objects is
  • how a TrinoCatalog object is linked with a TrinoCluster

Acceptance criteria:

  • there exists a concept page that explains how the TrinoCatalog works
  • there exists a guide page on how to use it
@soenkeliebau soenkeliebau added the good first issue Good for newcomers label Sep 6, 2022
@soenkeliebau soenkeliebau changed the title Add more extensive documentation on how to add catalogs to Trino instances Documentation: Add more extensive documentation on how to add catalogs to Trino instances Sep 6, 2022
@fhennig
Copy link
Member

fhennig commented Sep 7, 2022

Alright, so far we have just put everything in the usage.adoc, but there is this ticket stackabletech/documentation#227 to improve on this.

There are four aspects to fullfil to document a feature like this ideally:

  • Concept - explain the CRD, how it relates to the TrinoCluster, why it was introduced and why in this way
  • Tutorial - A simple tutorial to deploy a toy catalog in the most simple way, in a controlled toy cluster to explain how it works. looking at trino and seeing the catalog in the WebUI (if that's a thing)
  • Guide - A guide on how to use this in production. This should help someone make use of the TrinoCatalog for their setup that they already have. The guide necessarily needs to cover many "if"s and "when"s. It should leave the user with something that is production ready, not a toy example like in a tutorial. It should include best practices
  • Reference - A reference page to exhaustively explain all the CRD options that are in the resource, and what they are for. This is something we want to generate in the future.

For now, I believe that a Concept page and a Guide page is most important. I don't think we need a tutorial for every little feature, I'd rather add more platform-level tutorials that show of a set of features together, which can then be linked if someone wants to learn hands on about the TrinoCluster CRD. But a conceptual explanation, as well as an exhausitve guide for a production ready setup is a must I believe.

I'm happy to refine this with someone! Please ping me if you're up for it.

@fhennig
Copy link
Member

fhennig commented Sep 15, 2022

Acceptance criteria:

  • there exists a concept page that explains how the TrinoCatalog works
  • there exists a guide page on how to use it

@adwk67
Copy link
Member

adwk67 commented Sep 20, 2022

@bors bors bot closed this as completed in 203b6d2 Sep 22, 2022
@lfrancke lfrancke self-assigned this Sep 28, 2022
@lfrancke
Copy link
Member

None of the boxes have been ticked. Have both been done?

@adwk67
Copy link
Member

adwk67 commented Oct 4, 2022

Both have been done and the boxes are now checked.

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

Successfully merging a pull request may close this issue.

5 participants