stackabletech / stackabletech/documentation

Operator overview pages for internal operators (commons, secret, listener)

Offen
#408 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

area/documentation size/M
Vorherrschende Sprache
CSS
Sterne
13
Forks
14
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
10

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das Folge-Issue #282 zu lesen und die vorhandene Dokumentation für die commons-, secret- und listener-Operatoren zu prüfen. Dokumentiere für jeden Operator seine Rollen, erstellten und beibehaltenen oder entfernten Ressourcen, Abhängigkeiten, Diagramme und Demo-Links. Die Arbeit ist abgeschlossen, wenn die Kontrollkästchen für alle drei Operatoren abgedeckt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.