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:
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
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:
getting_startedexists, with anindex.adoc, ainstallation.adocandfirst_steps.adocinstallation.adocis removed.yamland shell snippets are in theexamples/codedirectory and can be executed as a script, to test the documentationtemplate_docs.shscript and thetemplating_vars.yamlfile.