stackabletech / stackabletech/documentation
Operator overview pages for internal operators (commons, secret, listener)
Open
Nobody has claimed this yet.
area/documentation
size/M
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
Description
Follow up to https://github.com/stackabletech/documentation/issues/282
Explain for every operator:
- which roles does it have and what do they mean?
- Which resources does it create:
- i.e. statefulsets per role
- configmap for discovery
- also a diagram
- which resources does it tear down again?
- for example, ConfigMaps and PVCs are staying
- what are the dependencies, what other operators does it connect to?
- link to demos
Operators:
- commons
- secret
- listener
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading follow-up issue #282 and inspect the existing documentation for the commons, secret, and listener operators. For each operator, document its roles, created and retained or removed resources, dependencies, diagrams, and demo links. The work is done when all three operator checkboxes are covered.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100