Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Cloud Native Computing Foundation (CNCF)
- Pisarz techniczny:
- Syam Sundar K
- Nazwa projektu:
- Więcej przykładów Kubectl
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Celem tego projektu jest ulepszenie istniejącej ściągawki z kubectl i dokumentów referencyjnych.
Oto główne cele tego projektu: • Tworzenie większej liczby i lepszych przykładów użycia narzędzia kubectl. • Dodaj przykłady kubectl do ściągawki kubectl. • Zrefaktoryzuj dokumenty kubectl, aby zwiększyć ich przydatność.
Cel I – przykłady użycia kubectl:
Będę ściśle współpracować z grupami o specjalnych zainteresowaniach związanych z interfejsem wiersza poleceń, aby uzyskać kontekst, jakich przykładów najbardziej potrzebują użytkownicy Kubernetes, i udokumentować ten kontekst. Możesz na przykład poprawić istniejące polecenia kubectl w ściągawce, a także dodać do niej nowe polecenia.
Cel II – zwiększona przydatność dokumentów:
Aby zwiększyć przydatność dokumentów, można wykonać następujące czynności:
• Wyeliminuj trudności na początku. • Zmieniaj kolejność poleceń kubectl w określonej kolejności, aby zapewnić ciągłość logicznego przepływu.
Wyeliminuj trudności początkujących dzięki lepszym objaśnieniom poleceń i przypadków użytkownika. Może się to wydawać proste, ale może w znacznym stopniu wpłynąć na to, czy osoby początkujące będą kontynuować naukę, albo ją przerwać. Na przykład kiedy zacząłem korzystać z kubernetes przez kubectl, nie wiedziałem o różnicach między podami a wdrożeniami. Początkowo wdrożyłem usługę backendu napisaną w Nodeą. Po kilku godzinach chciałem go wyłączyć, więc próbowałem usunąć poda, ale ze względu na samonaprawę pody zostały utworzone ponownie. Byłam raczej zaskoczona tym, co się tutaj dzieje, i zastanawiam się, dlaczego treści zostały odtworzone, a nie usunięte. Po kilku wyszukiwaniach w internecie udało mi się, że usunięcie podów nie jest równoznaczne z usunięciem wdrożenia. Wychwycony dokument może wydawać się prosty, ale jasne wyjaśnienie, które eliminuje tego rodzaju niejasności, odróżnia dobry dokument od doskonałego.
Zmiana położenia polecenia kubectl w określonej kolejności w celu zapewnienia ciągłości w przepływie logicznym. Każdy, kto tak jak ja mocno wierzy w historię opowiadania historii, zapewne zastanawia się, jak przenieść elementy tej opowieści do arkusza dokumentu z listą poleceń terminala, to mówiąc, można to zrobić. Wszystko, czego się uczymy, zawsze ma logiczny przepływ: początek i koniec. Kubectl jako narzędzie wiersza poleceń ma oczywiście krzywą uczenia się. W rzeczywistości jego krzywa uczenia się zbiega się z krzywą uczenia się samej platformy Kubernetes. Prawie każdy zaczyna przygodę z kubernetami od kubectl (z wyjątkiem użytkowników korzystających z interfejsu internetowego), a ponieważ krzywa uczenia się jest ściśle połączona z krzywą uczenia się kubernetes, dokumenty można znacznie ulepszyć, zmieniając kolejność tych poleceń i wprowadzając do nich elementy narracyjne. Jeśli chodzi o instancję, funkcje takie jak autoskalowanie podów w poziomie można wyjaśnić po objaśnieniu zasobów za pomocą rzeczywistych przykładów i ilustracji.
Cel III – Zwiększenie łatwości obsługi dokumentów:
Niedawna migracja witryny Kubernetes do Docsy Hugo jest niesamowita i wprowadza ogromną zmianę w perspektywie dokumentów. Migracja się udała, ale w dokumencie można jeszcze wprowadzić wiele ulepszeń.
Proponuję kilka zmian:
• Automatyczne przewijanie lewego panelu do obecnie aktywnej sekcji głównej dokumentów – ta funkcja może ułatwić śledzenie bieżących, przyszłych i przeszłych sekcji. • Kopiuj do schowka – niektóre polecenia mogą być długie, a funkcja kopiowania może być przydatna podczas pracy z tego rodzaju poleceniami. • Formatowanie treści plików dokumentów – po migracji zawartość kilku stron jest nieprawidłowo sformatowana (np. w sekcji Typ zasobu w przeglądzie kubectl). Pogarsza to wygodę użytkowników.
Wprowadzone zmiany mogą zwiększyć komfort użytkowników witryny Kubernetes, a także zwiększyć ich produktywność.