Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Cloud Native Computing Foundation (CNCF)
- Specjalista ds. technicznych:
- Syam Sundar K
- Nazwa projektu:
- Więcej i lepszych przykładów komend Kubectl
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Celem tego projektu jest udoskonalenie istniejących kartek z poradami i dokumentów referencyjnych kubectl.
Oto główne cele tego projektu: • tworzyć więcej i lepsze przykłady kubectl. • dodać przykłady kubectl do cheat sheet kubectl; • Zmodyfikuj dokumenty kubectl, aby uzyskać maksymalną przydatność.
Cel I – przykłady dotyczące kubectl:
Będziemy ściśle współpracować z grupami zainteresowań CLI, aby poznać kontekst, w którym użytkownicy kubernetesa chcą najczęściej używać przykładów, i udokumentować te przykłady. Może to obejmować ulepszenie istniejących poleceń kubectl w podręczniku lub dodanie nowych poleceń.
Cel II – zwiększenie przydatności dokumentów:
Aby zwiększyć przydatność dokumentów, możesz wykonać te czynności:
• Usuwanie problemów początkujących • Przestawianie poleceń kubectl w określonym porządku, aby zapewnić ciągłość przepływu logicznego
Usuń problemy początkujących dzięki lepszym wyjaśnieniom poleceń i przypadków użycia. Może się to wydawać proste, ale może znacząco wpłynąć na to, czy początkujący będą kontynuować naukę, czy zrezygnują z niej. Na przykład, gdy zaczynałam korzystać z Kubernetes za pomocą kubectl, nie byłam pewna różnicy między podami a wdrożeniami. Początkowo wdrożono usługę backendową napisaną w języku nodejs. Po kilku godzinach chciałem go usunąć, więc próbowałem go usunąć, ale ze względu na samonaprawianie się podów zostały utworzone ponownie. Nie bardzo rozumiałem, co się dzieje, i nie wiedziałem, dlaczego konto jest ponownie tworzone, a nie usuwane. Po kilku wyszukiwaniach w internecie dowiedziałem się, że usuwanie podów nie jest tym samym, co usuwanie wdrożenia. Dla wprawnego oka może się to wydawać proste, ale jasne wyjaśnienie, które eliminuje tego typu niejasności, odróżnia dobry dokument od dobrego dokumentu.
Zmiana kolejności poleceń kubectl w określonym porządku, aby zapewnić ciągłość przepływu logicznego. Jeśli ktoś tak jak ja mocno wierzy w historię, zapewne zastanawiasz się, jak przenieść elementy narracji do arkusza dokumentów, który zawiera listę poleceń terminala. Myślę, że jest to możliwe. Wszystko, czego się uczymy, ma zawsze logiczny przebieg – punkt początkowy i końcowy. Kubectl to narzędzie wiersza poleceń, które ma oczywiście krzywą uczenia się, a w rzeczywistości krzywa uczenia się zbiega się z krzywą uczenia się samej Kubernetes. Praktycznie każdy zaczyna swoją przygodę z kubernetesem od kubectl (z wyjątkiem osób, które korzystają z interfejsu internetowego), a krzywe uczenia się są ściśle powiązane z krzywą uczenia się kubernetesa. Można znacznie ulepszyć dokumentację, zmieniając kolejność tych poleceń i wprowadzając elementy opowiadania historii. Na przykład funkcje takie jak poziome autoskalowanie podów można wyjaśnić po omówieniu zasobów z przykładami i ilustracjami z prawdziwego świata.
Cel III – Ulepszenia łatwości obsługi Dokumentów:
Niedawna migracja witryny Kubernetes do Dokumentów Hugo jest świetna i zapewnia ogromną przemianę w perspektywie dotyczącej dokumentów. Chociaż migracja przebiegła pomyślnie, nadal można wiele ulepszyć w przestrzeni dokumentu.
Oto kilka zmian, które warto wprowadzić:
• automatyczne przewijanie lewego panelu do aktualnie aktywnej sekcji w dokumentach głównych – może to ułatwić śledzenie bieżących, nadchodzących i minionych sekcji; • Skopiuj do schowka – niektóre polecenia mogą być długie. Funkcja kopiowania może być pomocna podczas pracy z tego typu poleceniami. • Formatowanie treści plików doc – po migracji zawartość kilku stron nie jest prawidłowo sformatowana, np. sekcja Typ zasobu w przeglądzie kubectl. W efekcie pogarsza się komfort korzystania z aplikacji.
Te zmiany mogą poprawić wrażenia użytkowników witryny kubernetes i zwiększyć ich produktywność.