stackabletech / stackabletech/documentation
Operator env vars documentation
Nessuno ha ancora preso questa issue.
- Lingua principale
- CSS
- Stelle
- 13
- Fork
- 14
- Merge medio
- 4g 8h
- PR unite (30g)
- 10
Descrizione
currently there is hand written docs for env vars and commandline parameters, but that in itself isn't useful.
The users want to set this with Helm, or somehow in OpenShift (or maybe with stackablectl?)
These things should go into the Reference section.
We should also think about maybe generating this if we can (but not necessary, as there are probably not that many settings). Maybe we can have instead common operator flags as a partial somewhere, that we can simply reference in all the operators.
related: https://github.com/stackabletech/documentation/issues/514
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la documentazione esistente, scritta manualmente, sulle variabili d’ambiente e sui parametri della riga di comando, quindi esamina le sezioni Reference e la issue correlata 514. Il lavoro è completato quando le impostazioni sono documentate in una forma che gli utenti possano applicare con Helm o OpenShift e qualsiasi decisione relativa a partial condivisi o generazione è riportata nella documentazione risultante.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- helm
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100