stackabletech / stackabletech/documentation

Operators: Turn examples into documentation

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

Dieses Issue hat noch niemand übernommen.

priority/low refinement-needed
Vorherrschende Sprache
CSS
Sterne
13
Forks
14
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
10

Beschreibung

We have the example directories in the operators, which are very useful for us devs to quicky deploy an instance of something. But the examples are not tested.

With the getting started guide we started moving examples into the docs and testing them. It would make sense to keep doing this, with the other examples as well. There are specific examples which deploy an instance + OPA etc., which we could turn into specific docs guides.

This would be an epic and needs to be done for all operators.

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 Verzeichnisse mit Operator-Beispielen und den Getting-Started-Leitfaden zu überprüfen, in dem Beispiele zunehmend in getestete Dokumentation überführt werden. Erfasse die verbleibenden Beispiele in allen Operatoren, identifiziere, welche zu spezifischen Leitfäden werden sollten, und definiere den Abschluss so, dass jedes ausgewählte Beispiel dokumentiert und getestet ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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