Skip to content

Docs: Getting started guide #220

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
5 tasks
fhennig opened this issue Aug 10, 2022 · 0 comments
Closed
5 tasks

Docs: Getting started guide #220

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

Comments

@fhennig
Copy link
Contributor

fhennig commented Aug 10, 2022

Part of this 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 Refinement: Waiting for in Stackable Engineering Aug 12, 2022
@adwk67 adwk67 assigned adwk67 and unassigned razvan and adwk67 Aug 16, 2022
@adwk67 adwk67 moved this from Refinement: Waiting for to Development: In Progress in Stackable Engineering Aug 18, 2022
bors bot pushed a commit that referenced this issue Aug 18, 2022
# Description

Getting-started docs.
Closes #220.
bors bot pushed a commit that referenced this issue Aug 19, 2022
# Description

Getting-started docs.
Closes #220.
@bors bors bot closed this as completed in 2e4160c Aug 19, 2022
Repository owner moved this from Development: In Progress to Refinement: In Progress in Stackable Engineering Aug 19, 2022
@adwk67 adwk67 moved this from Refinement: In Progress to Development: Done in Stackable Engineering Aug 22, 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.

3 participants