Das ist eine für den Ausdruck optimierte Ansicht des gesamten Kapitels inkl. Unterseiten. Druckvorgang starten.

Zur Standardansicht zurückkehren.

Bei SIG Docs mitmachen

Die SIG Docs ist eine der Special Interest Groups (Fachspezifischen Interessengruppen) innerhalb des Kubernetes-Projekts, die sich auf das Schreiben, Aktualisieren und Pflegen der Dokumentation für Kubernetes als Ganzes konzentriert. Weitere Informationen über die SIG findest du unter SIG Docs im GitHub Repository der Community.

SIG Docs begrüßt Inhalte und Bewertungen von allen Mitwirkenden. Jeder kann einen Pull Request (PR) eröffnen, und jeder ist willkommen, Fragen zum Inhalt zu stellen oder Kommentare zu laufenden Pull Requests abzugeben.

Du kannst dich ausserdem als Member, Reviewer, oder Approver beteiligen. Diese Rollen erfordern einen erweiterten Zugriff und bringen bestimmte Verantwortlichkeiten zur Genehmigung und Bestätigung von Änderungen mit sich. Unter community-membership findest du weitere Informationen darüber, wie die Mitgliedschaft in der Kubernetes-Community funktioniert.

Der Rest dieses Dokuments umreißt einige spezielle Vorgehensweisen dieser Rollen innerhalb von SIG Docs, die für die Pflege eines der öffentlichsten Aushängeschilder von Kubernetes verantwortlich ist - die Kubernetes-Website und die Dokumentation.

SIG Docs Vorstand

Jede SIG, auch die SIG Docs, wählt ein oder mehrere SIG-Mitglieder, die als Vorstand fungieren. Sie sind die Kontaktstellen zwischen der SIG Docs und anderen Teilen der der Kubernetes-Organisation. Sie benötigen umfassende Kenntnisse über die Struktur des Kubernetes-Projekts als Ganzes und wie SIG Docs darin arbeitet. Hier findest alle weiteren Informationen zu den aktuellen Vorsitzenden und der Leitung.

SIG Docs-Teams und Automatisierung

Die Automatisierung in SIG Docs stützt sich auf zwei verschiedene Mechanismen: GitHub-Teams und OWNERS-Dateien.

GitHub Teams

Es gibt zwei Kategorien von SIG Docs Teams auf GitHub:

  • @sig-docs-{language}-owners sind Genehmiger und Verantwortliche
  • @sig-docs-{language}-reviews sind Reviewer

Jede Gruppe kann in GitHub-Kommentaren mit ihrem @name referenziert werden, um mit allen Mitgliedern dieser Gruppe zu kommunizieren.

Manchmal überschneiden sich Prow- und GitHub-Teams, ohne eine genaue Übereinstimmung. Für die Zuordnung von Issues, Pull-Requests und zur Unterstützung von PR-Genehmigungen verwendet die Automatisierung die Informationen aus den OWNERS-Dateien.

OWNERS Dateien und Front-Matter

Das Kubernetes-Projekt verwendet ein Automatisierungstool namens prow für die Automatisierung im Zusammenhang mit GitHub-Issues und Pull-Requests. Das Kubernetes-Website-Repository verwendet zwei prow-Plugins:

  • blunderbuss
  • approve

Diese beiden Plugins nutzen die OWNERS und OWNERS_ALIASES Dateien auf der obersten Ebene des GitHub-Repositorys kubernetes/website, um zu steuern wie prow innerhalb des Repositorys arbeitet.

Eine OWNERS-Datei enthält eine Liste von Personen, die SIG Docs-Reviewer und Genehmiger sind. OWNERS-Dateien können auch in Unterverzeichnissen existieren und bestimmen, wer Dateien in diesem Unterverzeichnis und seinen Unterverzeichnissen als Gutachter oder Genehmiger bestätigen darf. Weitere Informationen über OWNERS-Dateien im Allgemeinen findest du unter OWNERS.

Außerdem kann eine einzelne Markdown-Datei in ihrem Front-Matter (Vorspann) Reviewer und Genehmiger auflisten. Entweder durch Auflistung einzelner GitHub-Benutzernamen oder GitHub-Gruppen.

Die Kombination aus OWNERS-Dateien und Front-Matter in Markdown-Dateien bestimmt, welche Empfehlungen PR-Eigentümer von automatisierten Systemen erhalten, und wen sie um eine technische und redaktionelle Überprüfung ihres PRs bitten sollen.

So funktioniert das Zusammenführen

Wenn ein Pull Request mit der Branch (Ast) zusammengeführt wird, in dem der Inhalt bereitgestellt werden soll, wird dieser Inhalt auf http://kubernetes.io veröffentlicht. Um sicherzustellen, dass die Qualität der veröffentlichten Inhalte hoch ist, beschränken wir das Zusammenführen von Pull Requests auf SIG Docs Freigabeberechtigte. So funktioniert es:

  • Wenn eine Pull-Anfrage sowohl das lgtm- als auch das approve-Label hat, kein hold-Label hat, und alle Tests bestanden sind, wird der Pull Request automatisch zusammengeführt.
  • Jedes Kubernetes-Mitglied kann das lgtm-Label hinzufügen, indem es einen /lgtm-Kommentar hinzufügt.
  • Mitglieder der Kubernetes-Organisation und SIG Docs-Genehmiger können kommentieren, um das automatische Zusammenführen eines Pull Requests zu verhindern (durch Hinzufügen eines /hold-Kommentars kann ein vorheriger /lgtm-Kommentar zurückgehalten werden).
  • Nur SIG Docs-Genehmiger können einen Pull Request zusammenführen indem sie einen /approve Kommentar hinzufügen. Einige Genehmiger übernehmen auch weitere spezielle Rollen, wie zum Beispiel PR Wrangler oder SIG Docs Vorsitzende.

Nächste Schritte

Weitere Informationen über die Mitarbeit an der Kubernetes-Dokumentation findest du unter:

1 - Rollen und Verantwortlichkeiten

Jeder kann zu Kubernetes beitragen. Wenn deine Beiträge zu SIG Docs wachsen, kannst du dich für verschiedene Stufen der Mitgliedschaft in der Community bewerben. Diese Rollen ermöglichen es dir, mehr Verantwortung innerhalb der Gemeinschaft zu übernehmen. Jede Rolle erfordert mehr Zeit und Engagement. Die Rollen sind:

  • Jeder: kann regelmäßig zur Kubernetes-Dokumentation beitragen
  • Member: können Issues zuweisen und einstufen und Pull Requests unverbindlich prüfen
  • Reviewer: können die Überprüfung von Dokumentations-Pull-Requests leiten und für die Qualität einer Änderung bürgen
  • Approver: können die Überprüfung von Dokumentations- und Merge-Änderungen leiten

Jeder

Jeder mit einem GitHub-Konto kann zu Kubernetes beitragen. SIG Docs heißt alle neuen Mitwirkenden willkommen!

Jeder kann:

Nach dem Signieren des CLA kann jeder auch:

  • eine Pull-Anfrage öffnen, um bestehende Inhalte zu verbessern, neue Inhalte hinzuzufügen oder einen Blogbeitrag oder eine Fallstudie zu schreiben
  • Diagramme, Grafiken und einbettbare Screencasts und Videos erstellen

Weitere Informationen findest du unter neue Inhalte beisteuern.

Member

Ein Member (Mitglied) ist jemand, der bereits mehrere Pull Requests an kubernetes/website eingereicht hat. Mitglieder sind ein Teil der Kubernetes GitHub Organisation.

Member können:

  • Alles tun, was unter Jeder aufgeführt ist

  • Den Kommentar /lgtm verwenden, um einem Pull Request das Label LGTM (looks good to me) hinzuzufügen

  • Verwende den Kommentar /hold, um das Zusammenführen eines Pull Requests zu blockieren.

  • Benutze den Kommentar /assign, um einem Pull Request einen Reviewer zuzuweisen.

  • Unverbindliche Überprüfung von Pull Requests

  • Nutze die Automatisierung, um Issues zu sortieren und zu kategorisieren

  • Neue Funktionen dokumentieren

Mitglied werden

Du kannst ein Mitglied werden, nachdem du mindestens 5 substantielle Pull Requests eingereicht hast und die anderen Anforderungen erforderst:

  1. Finde zwei Reviewer oder Approver, die deine Mitgliedschaft sponsern.

    Bitte um Sponsoring im #sig-docs channel on Slack oder auf der SIG Docs Mailingliste.

  2. Eröffne ein GitHub-Issue im kubernetes/org Repository. Verwende dabei das Organization Membership Request issue template.

  3. Informiere deine Sponsoren über das GitHub-Issue. Du kannst entweder:

    • Ihren GitHub-Benutzernamen in deinem Issue (@<GitHub-Benutzername>) erwähnen

    • Ihnen den Issue-Link über Slack oder per E-Mail senden.

      Die Sponsoren werden deine Anfrage mit einer "+1"-Stimme genehmigen. Sobald deine Sponsoren genehmigen, fügt dich ein Kubernetes-GitHub-Admin als Mitglied hinzu. Herzlichen Glückwunsch!

      Wenn dein Antrag auf Mitgliedschaft nicht angenommen wird, erhältst du eine Rückmeldung. Nachdem du dich mit dem Feedback auseinandergesetzt hast, kannst du dich erneut bewerben.

  4. Nimm die Einladung zur Kubernetes GitHub Organisation in deinem E-Mail-Konto an.

Reviewer

Reviewer (Gutachteren) sind dafür verantwortlich, offene Pull Requests zu überprüfen. Anders als bei den Mitgliedern musst du auf das Feedback der Prüfer eingehen. Reviewer sind Mitglieder des @kubernetes/sig-docs-{language}-reviews GitHub-Teams.

Gutachteren können:

  • Alles tun, was unter Jeder und Member aufgeführt ist

  • Pull Requests überprüfen und verbindliches Feedback geben

  • Bearbeite benutzerseitige Zeichenfolgen im Code

  • Verbessere Code-Kommentare

Zuweisung von Reviewern zu Pull Requests

Die Automatisierung weist allen Pull Requests Reviewer zu. Du kannst eine Review von einer bestimmten Person anfordern, indem du einen Kommentar schreibst: /assign [@_github_handle].

Wenn der zugewiesene Prüfer den PR nicht kommentiert hat, kann ein anderer Prüfer einspringen. Du kannst bei Bedarf auch technische Prüfer zuweisen.

Verwendung von /lgtm

LGTM steht für "Looks good to me" und zeigt an, dass ein Pull Request technisch korrekt und bereit zum Zusammenführen ist. Alle PRs brauchen einen /lgtm Kommentar von einem Reviewer und einen /approve Kommentar von einem Approver, um zusammengeführt zu werden.

Ein /lgtm-Kommentar vom Reviewer ist verbindlich und löst eine Automatisierung aus, die das lgtm-Label hinzufügt.

Reviewer werden

Wenn du die Anforderungen erfüllst, kannst du ein SIG Docs-Reviewer werden. Reviewer in anderen SIGs müssen sich gesondert für den Reviewer-Status in SIG Docs bewerben.

So bewirbst du dich:

  1. Eröffne einen Pull Request, in dem du deinen GitHub-Benutzernamen in einen Abschnitt der OWNERS_ALIASES Datei im kubernetes/website Repository hinzufügt.

  2. Weise den PR einem oder mehreren SIG-Docs-Genehmigern zu (Benutzernamen, die unter sig-docs-{language}-owners aufgelisted sind). Wenn der PR genehmigt wurde, fügt dich ein SIG Docs-Lead dem entsprechenden GitHub-Team hinzu. Sobald du hinzugefügt bist, wird @k8s-ci-robot dich als Reviewer für neue Pull Requests vorschlagen und zuweisen.

Approver

Approver (Genehmiger) prüfen und genehmigen Pull Requests zum Zusammenführen. Genehmigende sind Mitglieder des @kubernetes/sig-docs-{language}-owners GitHub-Teams.

Genehmigende können Folgendes tun:

  • Alles, was unter Jeder, Member und Reviewer aufgeführt ist
  • Inhalte von Mitwirkenden veröffentlichen, indem sie Pull Requests mit dem Kommentar /approve genehmigen und zusammenführen
  • Verbesserungen für den Style Guide vorschlagen
  • Verbesserungsvorschläge für Docs-Tests einbringen
  • Verbesserungsvorschläge für die Kubernetes-Website oder andere Tools machen

Wenn der PR bereits einen /lgtm hat, oder wenn der Genehmigende ebenfalls mit /lgtm kommentiert, wird der PR automatisch zusammengeführt. Ein SIG Docs-Genehmiger sollte nur ein /lgtm für eine Änderung hinterlassen, die keine weitere technische Überprüfung erfordert.

Pull Requests genehmigen

Genehmiger und SIG Docs-Leads sind die Einzigen, die Pull Requests in das Website-Repository aufnehmen. Damit sind bestimmte Verantwortlichkeiten verbunden.

  • Genehmigende können den Befehl /approve verwenden, der PRs in das Repository einfügt.

  • Vergewissere dich, dass die vorgeschlagenen Änderungen den Beitragsrichtlinien entsprechen.

    Wenn du jemals eine Frage hast oder dir bei etwas nicht sicher bist, fordere einfach Hilfe an, um eine zusätzliche Überprüfung zu erhalten.

  • Vergewissere dich, dass die Netlify-Tests erfolgreich sind, bevor du einen PR mittels /approve genehmigst.

    Netlify-Tests müssen vor der Freigabe bestanden werden

  • Besuche die Netlify-Seitenvorschau für den PR, um sicherzustellen, dass alles gut aussieht, bevor du es genehmigst.

  • Nimm am PR Wrangler Rotationsplan für wöchentliche Rotationen teil. SIG Docs erwartet von allen Genehmigern, dass sie an dieser Rotation teilnehmen. Siehe PR-Wranglers. für weitere Details.

Approver werden

Wenn du die Anforderungen erfüllst, kannst du ein SIG Docs Approver werden. Genehmigende in anderen SIGs müssen sich separat für den Approver-Status in SIG Docs bewerben.

So bewirbst du dich:

  1. Eröffne eine Pull-Anfrage, in der du dich in einem Abschnitt der OWNERS_ALIASES Datei im kubernetes/website Repository hinzuzufügen.

  2. Weise den PR einem oder mehreren aktuellen SIG Docs Genehmigern zu.

Wenn der PR genehmigt wurde, fügt dich ein SIG Docs-Lead dem entsprechenden GitHub-Team hinzu. Sobald du hinzugefügt bist, wird @k8s-ci-robot dich als Reviewer für neue Pull Requests vorschlagen und zuweisen.

Nächste Schritte

  • Erfahre mehr über PR-Wrangling, eine Rolle, die alle Genehmiger im Wechsel übernehmen.

2 - PR Wranglers

SIG Docs approvers übernehmen einwöchige Schichten um die Pull Requests des Repositories zu verwalten.

Dieser Abschnitt behandelt die Aufgaben eines PR-Wranglers. Weitere Informationen über gute Reviews findest du unter Überprüfen von Änderungen.

Aufgaben

Tägliche Aufgaben in einer einwöchigen Schicht als PR Wrangler:

  • Sortiere und kennzeichne täglich eingehende Probleme. Siehe Einstufung und Kategorisierung von Problemen für Richtlinien, wie SIG Docs Metadaten verwendet.
  • Überprüfe offene Pull Requests auf Qualität und Einhaltung der Style und Content Leitfäden.
    • Beginne mit den kleinsten PRs (size/XS) und ende mit den größten (size/XXL). Überprüfe so viele PRs, wie du kannst.
  • Achte darauf, dass die PR-Autoren den CLA unterschreiben.
    • Verwende dieses Skript, um diejenigen, die den CLA noch nicht unterschrieben haben, daran zu erinnern, dies zu tun.
  • Gib Feedback zu den Änderungen und bitte die Mitglieder anderer SIGs um technische Überprüfung.
    • Gib inline Vorschläge für die vorgeschlagenen inhaltlichen Änderungen in den PR ein.
    • Wenn du den Inhalt überprüfen musst, kommentiere den PR und bitte um weitere Details.
    • Vergebe das/die entsprechende(n) sig/-Label.
    • Falls nötig, weise die Reviever aus dem Block revievers: im Vorspann der Datei zu.
  • Benutze den Kommentar /approve, um einen PR zum Zusammenführen zu genehmigen. Führe den PR zusammen, wenn er inhaltlich und technisch einwandfrei ist.
    • PRs sollten einen /lgtm-Kommentar von einem anderen Mitglied haben, bevor sie zusammengeführt werden.
    • Erwäge, technisch korrekte Inhalte zu akzeptieren, die nicht den Stilrichtlinien entsprechen. Eröffne ein neues Thema mit dem Label good first issue, um Stilprobleme anzusprechen.

Hilfreiche GitHub-Anfragen für Wranglers

Die folgenden Anfragen sind beim Wrangling hilfreich. Wenn du diese Anfragen abgearbeitet hast, ist die verbleibende Liste der zu prüfenden PRs meist klein. Diese Anfragen schließen Lokalisierungs-PRs aus. Alle Anfragen beziehen sich auf den main-Branch, außer der letzten.

  • Kein CLA, nicht zusammenfürbar: Erinnere den Beitragenden daran, den CLA zu unterschreiben. Wenn sowohl der Bot als auch ein Mensch sie daran erinnert haben, schließe den PR und erinnere die Autoren daran, dass sie ihn erneut öffnen können, nachdem sie den CLA unterschrieben haben. Überprüfe keine PRs, deren Autoren den CLA nicht unterschrieben haben!
  • Benötigt LGTM: Listet PRs auf, die ein LGTM von einem Mitglied benötigen. Wenn der PR eine technische Überprüfung benötigt, schalte einen der vom Bot vorgeschlagenen Reviewer ein. Wenn der Inhalt überarbeitet werden muss, füge Vorschläge und Feedback in-line hinzu.
  • Hat LGTM, braucht die Zustimmung von Docs: Listet PRs auf, die einen /approve-Kommentar benötigen, um zusammengeführt zu werden.
  • Quick Wins: Listet PRs gegen den Hauptzweig auf, die nicht eindeutig blockiert sind. (ändere "XS" in der Größenbezeichnung, wenn du dich durch die PRs arbeitest [XS, S, M, L, XL, XXL]).
  • Nicht gegen den main-Branch: Wenn der PR gegen einen dev-Ast gerichtet ist, ist er für eine kommende Veröffentlichung. Weise diesen dem Docs Release Manager zu: /assign @<manager's_github-username>. Wenn der PR gegen einen alten Ast gerichtet ist, hilf dem Autor herauszufinden, ob er auf den richtigen Ast gerichtet ist.

Hilfreiche Prow-Befehle für Wranglers

# Englisches Label hinzufügen
/language en

# füge dem PR ein Squash-Label hinzu, wenn es mehr als einen Commit gibt
/label tide/merge-method-squash

# einen PR ueber Prow neu betiteln (z.B. als Work-in-Progress [WIP])
/retitle [WIP] <TITLE>

Wann sind Pull Requests zu schließen

Reviews und Genehmigungen sind ein Mittel, um unsere PR-Warteschlange kurz und aktuell zu halten. Ein weiteres Mittel ist das Schließen.

PRs werden geschlossen, wenn:

  • Der Autor den CLA seit zwei Wochen nicht unterschrieben hat.

    Die Autoren können den PR wieder öffnen, nachdem sie den CLA unterschrieben haben. Dies ist ein risikoarmer Weg, um sicherzustellen, dass nichts zusammengeführt wird, ohne dass ein CLA unterzeichnet wurde.

  • Der Autor hat seit Zwei oder mehr Wochen nicht auf Kommentare oder Feedback geantwortet.

Hab keine Angst, Pull Requests zu schließen. Mitwirkende können sie leicht wieder öffnen und die laufenden Arbeiten fortsetzen. Oft ist es die Nachricht über die Schließung, die einen Autor dazu anspornt, seinen Beitrag wieder aufzunehmen und zu beenden.

Um eine Pull-Anfrage zu schließen, hinterlasse einen /close-Kommentar zu dem PR.