Edit This Page

Zur Kubernets-Dokumentation beitragen

Wenn Sie an der Dokumentation oder der Website von Kubernetes mitwirken möchten, freuen wir uns über Ihre Hilfe! Jeder kann seinen Beitrag leisten, unabhängig davon ob Sie neu im Projekt sind oder schon lange dabei sind, und ob Sie sich als Entwickler, Endbenutzer oder einfach jemanden, der es einfach nicht aushält, Tippfehler zu sehen sehen.

Weitere Möglichkeiten, sich in der Kubernetes-Community zu engagieren oder mehr über uns zu erfahren, finden Sie auf der Kubernetes-Community-Seite. Informationen zum Handbuch zur Dokumentation von Kubernetes finden Sie im Gestaltungshandbuch.

Arten von Mitwirkenden

  • Ein Member der Kubernetes Organisation, hat die CLA unterzeichnet und etwas Zeit und Energie zum Projekt beigetragen. Siehe Community-Mitgliedschaft für spezifische Kriterien bezüglich der Mitgliedschaft.
  • Ein SIG Docs Reviewer ist ein Mitglied der Kubernetes-Organisation, das Interesse an der Überprüfung von Dokumentationsanfragen geäußert hat und von einem SIG Docs Approver zu der entsprechenden Github-Gruppe und den OWNERS-Dateien im Github-Repository hinzugefügt wurde.
  • Ein SIG Docs approver ist ein Mitglied mit gutem Ansehen, das sich kontinuierlich für das Projekt engagiert hat. Ein Approver kann Pull-Anfragen zusammenführen und Inhalte im Namen der Kubernetes-Organisation veröffentlichen. Approver können SIG Docs auch in der größeren Kubernetes-Community vertreten. Einige der Aufgaben eines SIG Docs Approvers, wie z.B. die Koordination einer Freigabe, erfordern einen erheblichen Zeitaufwand.

Möglichkeiten, einen Beitrag zu leisten

Diese Liste ist in Funktionen unterteilt, die jeder tun kann, die von Mitgliedern der Kubernetes-Organisation durchgeführt werden können, und Dinge, die ein höheres Maß an Zugriff und eine bessere Kenntnis der SIG Docs-Prozesse erfordern. Wenn Sie im Laufe der Zeit einen konstanten Beitrag leisten, können Sie einige der bereits getroffenen Tools und organisatorischen Entscheidungen nachvollziehen.

Dies ist keine vollständige Liste von Möglichkeiten, wie Sie zur Kubernetes-Dokumentation beitragen können, aber sie sollte Ihnen den Einstieg erleichtern.

  • Jeder
    • Umsetzbare issues eröffnen
  • Member
    • Vorhandene Dokumente verbessern
    • Ideen zur Verbesserung in Slack oder der SIG docs Mailingliste einbringen
    • Den Zugriff auf Dokumente verbessern
    • Unverbindliches Feedback zu PRs verfassen
    • Enen Blogbeitrag oder eine Fallstudie schreiben
  • Reviewer
    • Neue Funktionen dokumentieren
    • Auswerten und Kategorisieren von Problemen
    • PRs überprüfen
    • Diagramme, Grafiken und einbettbare Screencasts / Videos erstellen
    • Lokalisierung
    • Als Vertreter von docs zu anderen Repos beitragen
    • An Benutzer gerichtete Zeichenfolgen im Code bearbeiten
    • Code-Kommentare verbessern, Godoc
  • Approver
    • Veröffentlichen Sie den Inhalt von Members, indem Sie PRs genehmigen und zusammenführen
    • Nehmen Sie als Docs-Vertreter an einem Kubernetes-Release-Team teil
    • Verbesserungsvorschläge für den Style Guide
    • Verbesserungsvorschläge für Dokumentprüfungen vorschlagen
    • Vorschläge für Verbesserungen der Kubernetes-Website oder anderer Tools
Lokalisierung der Kubernetes Dokumentation