Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Cloud Native Computing Foundation (CNCF)
- Technischer Redakteur:
- Syam Sundar K
- Projektname:
- Weitere und bessere Beispiele für kubectl
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Ziel dieses Projekts ist es, den vorhandenen Spickzettel und die Referenzdokumente zu kubectl zu erweitern.
Das sind die Hauptziele dieses Projekts: • Mehr und bessere kubectl-Beispiele erstellen. • kubectl-Beispiele zur kubectl-Übersicht hinzufügen. • Die kubectl-Dokumentation wurde überarbeitet, um sie möglichst hilfreich zu gestalten.
Ziel I – Beispiele für kubectl:
Wir arbeiten eng mit den Interessengruppen der Befehlszeile zusammen, um herauszufinden, welche Art von Beispielen die Kubernetes-Nutzer am meisten benötigen, und diese zu dokumentieren. Das kann von der Verbesserung der vorhandenen kubectl-Befehle in der Cheatsheet bis hin zum Hinzufügen neuer Befehle reichen.
Ziel II: Hilfreichere Dokumente:
Um die Nützlichkeit der Dokumente zu erhöhen, können Sie Folgendes tun:
• Einstiegshürden beseitigen • kubectl-Befehle in einer bestimmten Reihenfolge neu anordnen, um für einen logischen Ablauf zu sorgen
Beseitigen Sie Probleme für Anfänger durch bessere Erläuterungen zu Befehlen und Anwendungsfällen. Das mag einfach erscheinen, kann aber Anfänger erheblich dazu veranlassen, entweder weiterzumachen oder ihre Lernphase abzubrechen. Als ich zum ersten Mal mit Kubernetes über kubectl gearbeitet habe, war ich mir nicht sicher, was genau der Unterschied zwischen Pods und Bereitstellungen ist. Ursprünglich habe ich einen Back-End-Dienst bereitgestellt, der in Node.js geschrieben war. Nach ein paar Stunden wollte ich ihn herunterfahren und versuchte, den Pod zu löschen. Aufgrund der Selbstheilungsfunktion der Pods wurden sie jedoch wieder erstellt. Ich war etwas verwirrt und fragte mich, warum die Datei immer wieder erstellt und nicht gelöscht wurde. Nach einigen Suchanfragen im Web habe ich herausgefunden, dass das Löschen von Pods nicht dasselbe ist wie das Löschen einer Bereitstellung. Für ein geschultes Auge mag dies einfach erscheinen, aber eine klare Erklärung, die diese Art von Unklarheiten beseitigt, ist das, was ein gutes Dokument von einem guten Dokument unterscheidet.
Neuanordnung des kubectl-Befehls in einer bestimmten Reihenfolge, um Kontinuität im logischen Ablauf zu gewährleisten. Wenn Sie wie ich ein großer Fan von Storytelling sind, fragen Sie sich wahrscheinlich, wie Sie Storytelling-Elemente in eine Tabelle mit einer Liste von Terminalbefehlen einbinden. Ich sage: Es ist möglich. Alles, was wir lernen, hat immer einen logischen Ablauf – wenn Sie wollen, einen Start- und einen Endpunkt. Kubectl ist ein Befehlszeilentool, das eine gewisse Lernkurve hat. Diese Lernkurve fällt mit der Lernkurve von Kubernetes selbst zusammen. Da so gut wie alle ihre ersten Schritte mit Kubernetes über kubectl beginnen (mit Ausnahme derjenigen, die die Web-UI verwenden) und da die Lernkurve eng mit der Lernkurve von Kubernetes verbunden ist, lässt sich die Dokumentation erheblich verbessern, indem die Reihenfolge dieser Befehle geändert und Storytelling-Elemente eingeführt werden. So können beispielsweise Funktionen wie das horizontale Pod-Autoscaling erklärt werden, nachdem Sie Ressourcen anhand von Beispielen und Abbildungen aus der Praxis erläutert haben.
Ziel III: Verbesserungen der Nutzerfreundlichkeit von Google Docs:
Die kürzliche Migration der Kubernetes-Website zu Docsy Hugo ist großartig und bedeutet eine massive Veränderung in der Dokumentation. Die Migration war zwar erfolgreich, aber es gibt noch viel Raum für Verbesserungen im Dokumentbereich.
Hier einige Vorschläge:
• Im linken Bereich wird automatisch zum derzeit aktiven Abschnitt in den Hauptdokumenten gescrollt. Das kann hilfreich sein, um den Überblick über die aktuellen, anstehenden und vergangenen Abschnitte zu behalten. • In die Zwischenablage kopieren: Einige Befehle können lang sein. Die Kopierfunktion kann bei der Arbeit mit solchen Befehlen hilfreich sein. • Inhaltsformatierung von DOC-Dateien: Nach der Migration sind die Inhalte auf einigen Seiten nicht richtig formatiert. Beispiel: Abschnitt „Ressourcentyp“ in der kubectl-Übersicht. Das beeinträchtigt die Nutzerfreundlichkeit.
Diese Änderungen können die Nutzererfahrung auf der Kubernetes-Website verbessern und auch die Produktivität steigern.