[de] Participating in SIG Docs
This commit is contained in:
Benedikt Rollik
parent
de826159ab
commit
c6f301bd08
|
|
@ -0,0 +1,98 @@
|
|||
---
|
||||
title: Bei SIG Docs mitmachen
|
||||
content_type: concept
|
||||
weight: 60
|
||||
card:
|
||||
name: contribute
|
||||
weight: 60
|
||||
---
|
||||
|
||||
<!-- overview -->
|
||||
|
||||
Die SIG Docs ist eine der
|
||||
[Special Interest Groups (Interessengruppen)](https://github.com/kubernetes/community/blob/master/sig-list.md) 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](https://github.com/kubernetes/community/tree/master/sig-docs).
|
||||
|
||||
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](/docs/contribute/participate/roles-and-responsibilities/#members),
|
||||
[Reviewer](/docs/contribute/participate/roles-and-responsibilities/#reviewers), oder
|
||||
[Approver](/docs/contribute/participate/roles-and-responsibilities/#approvers) beteiligen.
|
||||
Diese Rollen erfordern einen erweiterten Zugriff und bringen bestimmte Verantwortlichkeiten für
|
||||
Änderungen zu genehmigen und zu bestätigen.
|
||||
Unter [community-membership](https://github.com/kubernetes/community/blob/master/community-membership.md) 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.
|
||||
|
||||
<!-- body -->
|
||||
## SIG Docs-Vorsitzender
|
||||
|
||||
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. Informationen zur [Führung](https://github.com/kubernetes/community/tree/master/sig-docs#leadership) und den aktuellen Vorsitzenden.
|
||||
## 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] (https://github.com/orgs/kubernetes/teams?query=sig-docs) auf GitHub:
|
||||
|
||||
- `@sig-docs-{language}-owners` sind Genehmiger und Verantwortliche
|
||||
- `@sig-docs-{language}-reviewers` sind Reviewer
|
||||
|
||||
Jede Gruppe kann in GitHub-Kommentaren mit ihrem `@name` referenziert werden, um mit
|
||||
mit allen Mitgliedern dieser Gruppe zu kommunizieren.
|
||||
|
||||
Manchmal überschneiden sich Prow- und GitHub-Teams, ohne genau übereinzustimmen. Für
|
||||
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-Problemen und Pull-Requests.
|
||||
Das [Kubernetes-Website-Repository](https://github.com/kubernetes/website) verwendet zwei [prow-Plugins](https://github.com/kubernetes/test-infra/tree/master/prow/plugins):
|
||||
|
||||
- blunderbuss
|
||||
- approve
|
||||
|
||||
Diese beiden Plugins verwenden die
|
||||
[OWNERS](https://github.com/kubernetes/website/blob/main/OWNERS) und
|
||||
[OWNERS_ALIASES](https://github.com/kubernetes/website/blob/main/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 Rezensent oder
|
||||
Genemiger bestätigen darf. Weitere Informationen über OWNERS-Dateien im Allgemeinen findest du unter
|
||||
[OWNERS](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md).
|
||||
|
||||
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 Ratschläge 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 veröffentlicht 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.
|
||||
- Mitglieder der Kubernetes-Organisation und SIG Docs-Genehmiger können Kommentare hinzufügen, um
|
||||
Kommentare hinzufügen, um das automatische Zusammenführen eines Pull Requests zu verhindern (durch Hinzufügen eines `/hold`-Kommentars
|
||||
kann ein vorheriger `/lgtm`-Kommentar zurückgehalten werden).
|
||||
- Jedes Kubernetes-Mitglied kann das `lgtm`-Label hinzufügen, indem es einen `/lgtm`-Kommentar hinzufügt.
|
||||
- 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](/docs/contribute/participate/pr-wranglers/) oder [SIG Docs Vorsitzende](#sig-docs-chairperson).
|
||||
|
||||
## {{% heading "whatsnext" %}}
|
||||
|
||||
Weitere Informationen über die Mitarbeit an der Kubernetes-Dokumentation findest du unter:
|
||||
|
||||
- [Neue Inhalte beisteuern](/docs/contribute/new-content/overview/)
|
||||
- [Inhalte überprüfen](/docs/contribute/review/reviewing-prs)
|
||||
- [Styleguide für die Dokumentation](/docs/contribute/style/)
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
---
|
||||
title: PR Wranglers
|
||||
content_type: concept
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<!-- overview -->
|
||||
|
||||
SIG Docs [approvers](/docs/contribute/participate/roles-and-responsibilities/#approvers) übernehmen einwöchige Schichten um die [Pull Requests](https://github.com/kubernetes/website/wiki/PR-Wranglers) des Repositories zu verwalten.
|
||||
|
||||
Dieser Abschnitt behandelt die Aufgaben eines PR-Wranglers. Weitere Informationen über gute Reviews findest du unter [Überprüfen von Änderungen](/docs/contribute/review/).
|
||||
<!-- body -->
|
||||
|
||||
## 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](/docs/contribute/review/for-approvers/#triage-and-categorize-issues) für Richtlinien, wie SIG Docs Metadaten verwendet.
|
||||
- Überprüfe [offene Pull Requests](https://github.com/kubernetes/website/pulls) auf Qualität und Einhaltung der [Style](/docs/contribute/style/style-guide/) und [Content](/docs/contribute/style/content-guide/) 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](https://github.com/kubernetes/community/blob/master/CLA.md) unterschreiben.
|
||||
- Verwende [dieses](https://github.com/zparnold/k8s-docs-pr-botherer) 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](/docs/contribute/style/style-guide/) 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 Hauptast, außer der letzten.
|
||||
|
||||
- [Kein CLA, nicht zusammenfürbar](https://github.com/kubernetes/website/pulls?q=is%3Aopen+ist%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3Alanguage%2Fen):
|
||||
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](https://github.com/kubernetes/website/pulls?q=is%3Aopen+ist%3Apr+-label%3A%22cncf-cla%3A+kein%22+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+-label%3Algtm):
|
||||
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](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge%2Fwork-in-progress+-label%3Ado-not-merge%2Fhold+label%3Alanguage%2Fen+label%3Algtm+):
|
||||
Listet PRs auf, die einen `/approve`-Kommentar benötigen, um zusammengeführt zu werden.
|
||||
- [Quick Wins](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amain+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22): 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 Hauptast](https://github.com/kubernetes/website/pulls?q=is%3Aopen+ist%3Apr+label%3Alanguage%2Fen+-base%3Amain): Wenn der PR gegen einen `dev-`Ast gerichtet ist, ist er für eine kommende Veröffentlichung. Weise diesen dem [Docs Release Manager](https://github.com/kubernetes/sig-release/tree/master/release-team#kubernetes-release-team-roles) 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 hinzufuegen
|
||||
/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 Pull Requests 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.
|
||||
|
||||
{{< note >}}
|
||||
|
||||
Der [`fejta-bot`](https://github.com/fejta-bot) Bot markiert Themen nach 90 Tagen Inaktivität als veraltet. Nach weiteren 30 Tagen markiert er Issues als faul und schließt sie. PR-Beauftragte sollten Themen nach 14-30 Tagen Inaktivität schließen.
|
||||
|
||||
{{< /note >}}
|
||||
|
|
@ -0,0 +1,227 @@
|
|||
---
|
||||
title: Rollen und Verantwortlichkeiten
|
||||
content_type: concept
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<!-- overview -->
|
||||
|
||||
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: trägt regelmäßig zur Kubernetes-Dokumentation bei
|
||||
- Member: können Probleme 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
|
||||
|
||||
<!-- body -->
|
||||
|
||||
## Jeder
|
||||
|
||||
Jeder mit einem GitHub-Konto kann zu Kubernetes beitragen. SIG Docs heißt alle neuen Mitwirkenden willkommen!
|
||||
|
||||
Jeder kann:
|
||||
|
||||
- Ein Problem in einem beliebigen [Kubernetes](https://github.com/kubernetes/)
|
||||
Repository, einschließlich
|
||||
[`kubernetes/website`](https://github.com/kubernetes/website)
|
||||
- Unverbindliches Feedback zu einem Pull Request geben
|
||||
- Zu einer Lokalisierung beitragen
|
||||
- Schlage Verbesserungen auf [Slack](https://slack.k8s.io/) oder der
|
||||
[SIG docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs).
|
||||
|
||||
Nach dem [Signieren des CLA](/docs/contribute/new-content/overview/#sign-the-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](/docs/contribute/new-content/).
|
||||
|
||||
## Member
|
||||
|
||||
Ein Member (Mitglied) ist jemand, der bereits mehrere Pull Requests an
|
||||
`kubernetes/website` eingereicht hat. Mitglieder sind ein Teil der
|
||||
[Kubernetes GitHub Organisation](https://github.com/kubernetes).
|
||||
|
||||
Member können:
|
||||
|
||||
- Alles tun, was unter [Jeder](#jeder) aufgeführt ist
|
||||
- Den Kommentar `/lgtm` verwenden, um einem Pull Request das Label LGTM (looks good to me) hinzuzufügen
|
||||
|
||||
{{< note >}}
|
||||
Die Verwendung von `/lgtm` löst eine Automatisierung aus. Wenn du eine unverbindliche
|
||||
Zustimmung geben willst, funktioniert der Kommentar "LGTM" auch!
|
||||
{{< /note >}}
|
||||
|
||||
- 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 Probleme zu sortieren und zu kategorisieren
|
||||
- Neue Funktionen dokumentieren
|
||||
|
||||
### Mitglied werden
|
||||
|
||||
Nachdem du mindestens 5 substantielle Pull Requests eingereicht hast und die anderen
|
||||
[Anforderungen](https://github.com/kubernetes/community/blob/master/community-membership.md#member):
|
||||
|
||||
1. Finde zwei [Reviewer](#reviewers) oder [Approver](#approvers), die deine Mitgliedschaft [sponsern](/docs/contribute/advanced#sponsor-a-new-contributor).
|
||||
|
||||
Bitte um Sponsoring im [#sig-docs channel on Slack](https://kubernetes.slack.com) oder auf der
|
||||
[SIG Docs Mailingliste](https://groups.google.com/forum/#!forum/kubernetes-sig-docs).
|
||||
|
||||
{{< note >}}
|
||||
Schicke keine direkte E-Mail oder Slack-Direktnachricht an ein einzelnes
|
||||
SIG Docs-Mitglied. Du musst das Sponsoring beantragen, bevor du deine Bewerbung einreichst.
|
||||
{{< /note >}}
|
||||
|
||||
1. Eröffne ein GitHub-Issue im
|
||||
[`kubernetes/org`](https://github.com/kubernetes/org/) Repository. Verwende dabei das
|
||||
**Organization Membership Request** issue template.
|
||||
|
||||
1. 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.
|
||||
|
||||
1. Nimm die Einladung zur Kubernetes GitHub Organisation in deinem E-Mail-Konto an.
|
||||
|
||||
{{< note >}}
|
||||
GitHub sendet die Einladung an die Standard-E-Mail-Adresse in deinem Konto.
|
||||
{{< /note >}}
|
||||
|
||||
## Reviewer
|
||||
|
||||
Reviewer (Rezensenten) 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](https://github.com/orgs/kubernetes/teams?query=sig-docs)
|
||||
GitHub-Teams.
|
||||
|
||||
Rezensenten können:
|
||||
|
||||
- Alles tun, was unter [Jeder](#jeder) und [Member](#member) aufgeführt ist
|
||||
- Pull Requests überprüfen und verbindliches Feedback geben
|
||||
|
||||
{{< note >}}
|
||||
Um unverbindliches Feedback zu geben, stellst du deinen Kommentaren eine Formulierung wie "Optional:" voran.
|
||||
{{< /note >}}
|
||||
|
||||
- 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](https://github.com/kubernetes/community/blob/master/community-membership.md#reviewer) 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](https://github.com/kubernetes/website/blob/main/OWNERS) Datei
|
||||
im `kubernetes/website` Repository hinzufügt.
|
||||
|
||||
{{< note >}}
|
||||
Wenn du dir nicht sicher bist, wo du dich hinzufügen sollst, füge dich zu `sig-docs-de-reviews` hinzu.
|
||||
{{< /note >}}
|
||||
|
||||
1. 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](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home)
|
||||
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](https://github.com/orgs/kubernetes/teams/?query=sig-docs)
|
||||
GitHub-Teams.
|
||||
|
||||
Genehmigende können Folgendes tun:
|
||||
|
||||
- Alles, was unter [Jeder](#jeder), [Member](#member) und [Reviewer](#reviewes) 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.
|
||||
|
||||
{{< warning >}}
|
||||
Ein unvorsichtiges Zusammenführen kann die Website lahmlegen, also sei dir sicher, dass du es auch so meinst, wenn du etwas zusammenführst.
|
||||
{{< /warning >}}
|
||||
|
||||
- Vergewissere dich, dass die vorgeschlagenen Änderungen den
|
||||
[Beitragsrichtlinien](/docs/contribute/style/content-guide/#contributing-content) 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.
|
||||
|
||||
<img src="/images/docs/contribute/netlify-pass.png" width="75%" alt="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](https://github.com/kubernetes/website/wiki/PR-Wranglers)
|
||||
für wöchentliche Rotationen teil. SIG Docs erwartet von allen Genehmigern, dass sie an dieser
|
||||
Rotation teilnehmen. Siehe [PR-Wranglers](/docs/contribute/participate/pr-wranglers/).
|
||||
für weitere Details.
|
||||
|
||||
### Ein Approver werden
|
||||
|
||||
Wenn du die [Anforderungen](https://github.com/kubernetes/community/blob/master/community-membership.md#approver) 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](https://github.com/kubernetes/website/blob/main/OWNERS)
|
||||
Datei im `kubernetes/website` Repository hinzuzufügen.
|
||||
|
||||
{{< note >}}
|
||||
Wenn du dir nicht sicher bist, wo du dich hinzufügen sollst, füge dich zu `sig-docs-de-owners` hinzu.
|
||||
{{< /note >}}
|
||||
|
||||
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](https://github.com/kubernetes/test-infra/tree/master/prow#bots-home)
|
||||
dich als Reviewer für neue Pull Requests vorschlagen und zuweisen.
|
||||
|
||||
## {{% heading "whatsnext" %}}
|
||||
|
||||
- Erfahre mehr über [PR-Wrangling](/docs/contribute/participate/pr-wranglers/), eine Rolle, die alle Genehmiger im Wechsel übernehmen.
|
||||
Loading…
Reference in New Issue