stackabletech / stackabletech/documentation

Operators: Turn examples into documentation

Open
#287 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority/low refinement-needed
Dominant language
CSS
Stars
13
Forks
14
Avg merge
4d 8h
Merged PRs (30d)
10

Description

We have the example directories in the operators, which are very useful for us devs to quicky deploy an instance of something. But the examples are not tested.

With the getting started guide we started moving examples into the docs and testing them. It would make sense to keep doing this, with the other examples as well. There are specific examples which deploy an instance + OPA etc., which we could turn into specific docs guides.

This would be an epic and needs to be done for all operators.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the operator example directories and the getting started guide, where examples have begun moving into tested documentation. Inventory the remaining examples across all operators, identify which should become specific guides, and define completion as each selected example being documented and tested.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.