stackabletech / stackabletech/documentation

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

Aperta
#408 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

area/documentation size/M
Lingua principale
CSS
Stelle
13
Fork
14
Merge medio
4g 8h
PR unite (30g)
10

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo la issue di follow-up #282 e consulta la documentazione esistente per gli operatori commons, secret e listener. Per ogni operatore, documenta i suoi ruoli, le risorse create e mantenute o rimosse, le dipendenze, i diagrammi e i link alle demo. Il lavoro è completato quando sono state coperte le caselle di controllo di tutti e tre gli operatori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.