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.

Sign up for GitHub

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

Jump to bottom

"Getting started" section across all operators #237

Closed
12 of 17 tasks
fhennig opened this issue Jul 7, 2022 · 3 comments
Closed
12 of 17 tasks

"Getting started" section across all operators #237

fhennig opened this issue Jul 7, 2022 · 3 comments
Assignees
@fhennig
Labels
epic release-note Denotes a PR that will be considered when it comes time to generate release notes.

Comments

@fhennig
Copy link
Contributor

fhennig commented Jul 7, 2022 •
edited by maltesander
Loading

We've decided that it would be good for onboarding new users to have a dedicated "Getting started" section in all operators.

It should contain

  • an "Install" page with instructions for how to install using either stackablectl or Helm
  • a "First steps" page with instructions on how to deploy an instance and verify that it is up, ideally with a simple task to do

This also relates to #204 - we should mention stackablectl in the install page (not done currently)

All the script and yaml files in there should be put into a shell script that can actually be executed, for testing purposes. Have a look at the druid docs, where this has been implemented already: /~https://github.com/stackabletech/druid-operator/tree/main/docs/modules/getting_started

Secret and Commons Operator don't need a Getting Started guide.

Acceptance criteria per operator:

  • a new module getting_started exists, with an index.adoc, a installation.adoc and first_steps.adoc
  • The old installation.adoc is removed.
  • All the yaml and shell snippets are in the examples/code directory and can be executed as a script, to test the documentation
  • versions to install are templated using the template_docs.sh script and the templating_vars.yaml file.
  • Any example files that are incorporated into the getting started guide are removed from the examples directory (because there they are not tested, with the new script they will be tested).
@fhennig fhennig mentioned this issue Jul 7, 2022
Closed
@fhennig fhennig self-assigned this Jul 25, 2022
@fhennig
Copy link
Contributor Author

fhennig commented Jul 25, 2022

As part of this, we can also tackle this ticket: stackabletech/issues#239

This was referenced Jul 25, 2022
Closed
Closed
bors bot pushed a commit to stackabletech/druid-operator that referenced this issue Aug 8, 2022
@fhennig
Getting started docs (#278)
8269381 
# Description

stackabletech/documentation#237

This is a first "getting started" section for an operator, which we hopefully can bring to other operators afterwards.

This replaces the old install page, and takes parts of the usage page and the examples to build it all into a "Getting started" guide/tutorial.

Also, all the script snippets are in one big script which can be executed and functions as a test.

Also, templating was introduced to be able to template operator versions into the script. I wanted to avoid this, but didn't see an alterantive way to get Helm and stackablectl to install the correct versions. I think with the templating there's just one file that needs to be adapted, which we can also automate in the future.

I've removed the simple-druid-cluster example, because that's now in the docs (and with the script it is also testable in a semi-automatic way: we can fully automate this in the future).

If this PR gets accepted, i'd like to put the `docs_templating.sh` script into operator-templating.



Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com>
@fhennig
Copy link
Contributor Author

fhennig commented Aug 8, 2022

Update: The Druid docs were merged.

  • All the code & scripts in the Getting Started guide is in an actual script that is testable
  • There's a small templating script for templating in the docs now.

@fhennig fhennig added the epic label Aug 8, 2022
This was referenced Aug 8, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
bors bot pushed a commit to stackabletech/superset-operator that referenced this issue Aug 10, 2022
@fhennig
Add getting started section (#246)
4e2a1a1 
# Description

stackabletech/documentation#237

*Please add a description here. This will become the commit message of the merge request later.*



Co-authored-by: Felix Hennig <fhennig@users.noreply.github.com>
This was referenced Aug 11, 2022
Closed
Closed
This was referenced Aug 16, 2022
Closed
Closed
@fhennig fhennig added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Aug 23, 2022
@maltesander
Copy link
Member

All done!

@fhennig fhennig mentioned this issue Sep 1, 2022
Closed
3 tasks
@fhennig fhennig mentioned this issue Dec 14, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fhennig fhennig

Labels
epic release-note Denotes a PR that will be considered when it comes time to generate release notes.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fhennig @maltesander