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

Docs: Getting started guide #113

Closed
5 tasks
fhennig opened this issue Aug 9, 2022 · 0 comments
Closed
5 tasks

Docs: Getting started guide #113

fhennig opened this issue Aug 9, 2022 · 0 comments
Assignees

Comments

@fhennig
Copy link
Contributor

fhennig commented Aug 9, 2022

This is part of the Epic: stackabletech/documentation#237

Acceptance criteria:

  • 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).
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Aug 12, 2022
@lfrancke lfrancke linked a pull request Aug 12, 2022 that will close this issue
7 tasks
@adwk67 adwk67 moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Aug 15, 2022
@adwk67 adwk67 closed this as completed Aug 15, 2022
Repository owner moved this from Development: In Review to Refinement: In Progress in Stackable Engineering Aug 15, 2022
@adwk67 adwk67 moved this from Refinement: In Progress to Development: Done in Stackable Engineering Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants