-
Notifications
You must be signed in to change notification settings - Fork 14k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/main' into dev-1.24
- Loading branch information
Showing
155 changed files
with
12,646 additions
and
2,228 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -153,6 +153,7 @@ aliases: | |
# dchen1107 | ||
# haibinxie | ||
# hanjiayao | ||
- howieyuen | ||
# lichuqiang | ||
- SataQiu | ||
- tanjunchen | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
--- | ||
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](https://github.com/kubernetes/community/blob/master/sig-list.md) (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](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](/de/docs/contribute/participate/roles-and-responsibilities/#member), | ||
[Reviewer](/de/docs/contribute/participate/roles-and-responsibilities/#reviewer), oder | ||
[Approver](/de/docs/contribute/participate/roles-and-responsibilities/#approver) beteiligen. | ||
Diese Rollen erfordern einen erweiterten Zugriff und bringen bestimmte Verantwortlichkeiten zur Genehmigung und Bestätigung von Änderungen mit sich. | ||
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 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](https://github.com/kubernetes/community/tree/master/sig-docs#leadership). | ||
|
||
## 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 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](https://github.com/kubernetes/website) verwendet zwei [prow-Plugins](https://github.com/kubernetes/test-infra/tree/master/prow/plugins): | ||
|
||
- blunderbuss | ||
- approve | ||
|
||
Diese beiden Plugins nutzen 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 Gutachter oder | ||
Genehmiger 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 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](/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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 `main`-Branch, 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 `main`-Branch](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 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. | ||
|
||
{{< 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 >}} |
Oops, something went wrong.