Operators: Turn examples into documentation
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Bereich
- documentation
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.
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.
- Vorherrschende Sprache
- CSS
- Sterne
- 13
- Forks
- 14
- Ø Merge
- 1 T. 13 Std.
- Gemergte PRs (30 T.)
- 29
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus stackabletech/documentation
-
Withdraw ADR018Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
stackabletech/documentation#734 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
stackabletech/documentation#779 ·
Maintainer antworten meist innerhalb von 1 Tag
-
customer-request
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
stackabletech/documentation#773 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
stackabletech/documentation#754 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100
stackabletech/documentation#753 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in stackabletech/documentation
Ähnliche Issues
-
area:docs area:render bug criticality:p3 triage:needs-implementation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
registrystack/registry-stack#1618 ·
Maintainer antworten meist innerhalb von 1 Tag
-
curriculum documentation quality
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
githubnext/gh-aw-workshop#3897 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
siderolabs/docs#791 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
nestjs/docs.nestjs.com#3554 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 98/100
huggingface/course#1320 ·
Maintainer antworten meist innerhalb von 1 Tag