stackabletech / stackabletech/documentation

Operator env vars documentation

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

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

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

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, die vorhandene, manuell erstellte Dokumentation zu Umgebungsvariablen und Befehlszeilenparametern zu finden, und überprüfe anschließend die Reference-Abschnitte sowie das zugehörige Issue 514. Als abgeschlossen gilt die Aufgabe, wenn die Einstellungen in einer Form dokumentiert sind, die Benutzer mit Helm oder OpenShift anwenden können, und jede Entscheidung über gemeinsam genutzte Partials oder Generierung in der daraus hervorgehenden Dokumentation festgehalten ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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