SIG Docs ist eine der Sonderinteressengruppen im Kubernetes-Projekt, die sich auf das Schreiben, Aktualisieren und Pflegen der Kubernetes-Dokumentation insgesamt konzentriert. Weitere Informationen zur SIG findest du unter SIG Docs im Community-GitHub-Repository.
SIG Docs begrüßt Inhalte und Reviews von allen Mitwirkenden. Jeder kann einen Pull Request (PR) öffnen, und jeder kann Issues zu Inhalten einreichen oder Kommentare zu laufenden Pull Requests hinterlassen.
Du kannst auch Mitglied, Reviewer oder Approver werden. Diese Rollen erfordern erweiterten Zugriff und bestimmte Verantwortlichkeiten für das Genehmigen und Zusammenführen von Änderungen. Weitere Informationen zur Mitgliedschaft in der Kubernetes-Community findest du unter community-membership.
Jede SIG, einschließlich SIG Docs, wählt ein oder mehrere SIG-Mitglieder als Vorsitzende. Diese sind Ansprechpersonen zwischen SIG Docs und anderen Teilen der Kubernetes-Organisation. Sie benötigen umfangreiche Kenntnisse über die Struktur des Kubernetes-Projekts insgesamt und wie SIG Docs darin funktioniert. Die aktuelle Liste der Vorsitzenden findest du unter Leadership.
Die Automatisierung in SIG Docs stützt sich auf zwei verschiedene Mechanismen: GitHub-Teams und OWNERS-Dateien.
Auf GitHub gibt es zwei Kategorien von SIG Docs Teams:
@sig-docs-{language}-owners sind Approver und Leads@sig-docs-{language}-reviews sind ReviewerJedes Team kann in GitHub-Kommentaren mit seinem @name referenziert werden,
um mit allen Mitgliedern der Gruppe zu kommunizieren.
Das Kubernetes-Projekt verwendet ein Automatisierungswerkzeug namens prow für die Automatisierung im Zusammenhang mit GitHub-Issues und Pull Requests. Das Kubernetes-Website-Repository verwendet zwei prow-Plugins: blunderbuss und approve.
Diese Plugins nutzen die
OWNERS- und
OWNERS_ALIASES-Dateien
im Hauptverzeichnis des kubernetes/website-Repositories.
Wenn ein Pull Request in den Branch zusammengeführt wird, der zum Veröffentlichen von Inhalten verwendet wird, werden diese Inhalte auf https://kubernetes.io veröffentlicht. Um die Qualität unserer veröffentlichten Inhalte sicherzustellen, beschränken wir das Zusammenführen von Pull Requests auf SIG Docs Approver.
lgtm- als auch das approve-Label hat, keine hold-Labels
vorhanden sind und alle Tests bestehen, wird der PR automatisch zusammengeführt.lgtm-Label hinzufügen./approve-Kommentar zusammenführen.Weitere Informationen zur Teilnahme an SIG Docs: