Operator overview pages for internal operators (commons, secret, listener)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
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.
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
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
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.
More from stackabletech/documentation
-
Withdraw ADR018 Open
Difficulty 1/5 Under an hour Newbie friendliness 68/100
stackabletech/documentation#734 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
stackabletech/documentation#779 ·
-
customer-request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stackabletech/documentation#773 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
stackabletech/documentation#754 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
stackabletech/documentation#753 ·
All issues in stackabletech/documentation
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
A11y ♿️
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
documentation improve or update documentation priority/low triage
Difficulty 2/5 Half a day Newbie friendliness 86/100
warpdotdev/docs#782 · 1 comment ·