Dokumentation im Rampenlicht: Wie SIG Docs Kubernetes vorantreibt
Erfahren Sie, wie die SIG Docs die Kubernetes-Dokumentation verbessert und neue Beiträge fördert.
Einleitung
Die offizielle Dokumentation ist die zentrale Anlaufstelle für jedes Open-Source-Projekt. Für Kubernetes ist dies eine ständig wachsende Special Interest Group (SIG), in der engagierte Mitglieder daran arbeiten, Informationen für neue Mitwirkende und Benutzer leicht zugänglich zu machen. SIG Docs veröffentlicht die offizielle Dokumentation auf kubernetes.io, die unter anderem die Dokumentation der Kern-APIs, architektonische Details und CLI-Tools umfasst, die mit den Kubernetes-Versionen ausgeliefert werden.
Um mehr über die Arbeit von SIG Docs und ihre zukünftigen Pläne zur Gestaltung der Community zu erfahren, habe ich meine Gespräche mit den Co-Vorsitzenden Divya Mohan (DM), Rey Lejano (RL) und Natali Vlatko (NV) zusammengefasst. Sie erläuterten die Ziele der SIG und wie andere Mitwirkende helfen können.
Zusammenfassung des Gesprächs
Könnten Sie uns ein wenig darüber erzählen, was SIG Docs macht?
SIG Docs ist die Special Interest Group für die Dokumentation des Kubernetes-Projekts auf kubernetes.io. Sie erstellt Referenzleitfäden für die Kubernetes-API, kubeadm
und kubectl
und pflegt die Infrastruktur und Analytik der offiziellen Website. Ihr Aufgabenbereich umfasst auch die Veröffentlichung von Dokumentationen, die Übersetzung von Inhalten, die Verbesserung und das Hinzufügen neuer Funktionen zu bestehenden Dokumentationen, das Pushen und Überprüfen von Inhalten für den offiziellen Kubernetes-Blog sowie die Zusammenarbeit mit dem Release-Team, um Dokumentationen und Blogs für jeden Zyklus zu überprüfen.
Blogs: Dieses Unterprojekt hebt neue oder abgeschlossene Kubernetes-Erweiterungen, Community-Berichte, SIG-Updates oder relevante Neuigkeiten für die Kubernetes-Community hervor, wie z. B. Führungsartikel, Tutorials und Projektupdates, wie die Entfernung von Dockershim und die bevorstehende Abschaffung von PodSecurityPolicy in der Version 1.25. Tim Bannister, einer der technischen Leiter von SIG Docs, leistet großartige Arbeit und ist eine treibende Kraft, wenn es darum geht, Beiträge in die Dokumentation und Blogs zu integrieren.
Lokalisierung: Mit diesem Unterprojekt konnte die Kubernetes-Community eine größere Inklusivität und Vielfalt unter Benutzern und Mitwirkenden erreichen. Dies hat auch dazu beigetragen, mehr Mitwirkende zu gewinnen, insbesondere Studenten, und dies geschah in den letzten Jahren. Ein herausragendes Beispiel für anstehende Lokalisierungen sind Hindi und Bengali. Die Bemühungen um die Hindi-Lokalisierung werden derzeit von Studenten in Indien geleitet.
Darüber hinaus gibt es zwei weitere Unterprojekte: reference-docs und die Website, die mit Hugo erstellt wurde und einen wichtigen Verantwortungsbereich darstellt.
Quelle: Kubernetes Blog