Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Jenkins X
- Pisarz techniczny:
- Nitin
- Nazwa projektu:
- refaktoryzacji istniejącej witryny z dokumentami Jenkins X i tabeli Jenkins X Capabilities Matrix
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Głównym celem tego projektu jest przebudowanie istniejącej dokumentacji Jenkinsa X, a także naprawienie problemów związanych z tymi dokumentami oraz przygotowanie zaktualizowanej tabeli możliwości Jenkinsa X wraz z dokumentacją użytkownika na temat korzystania z Jenkinsa X w przypadku dostawców chmury dla firm. W ramach tego projektu w współpracy z Danielem będziemy też pracować nad rozwojem infrastruktury środowiska Jenkins X w wersji zapoznawczej na podstawie OpenShift.
W ramach refaktoryzacji istniejącej dokumentacji Jenkinsa X pracuję nad tymi problemami:
- Uruchamianie w zasobach EKS: problem
- Vault nie działa w EKS z Boot: Issue
- envars dokumentów dla rozruchu jx: problem
- Dokumentacja wymagana do konfiguracji Vault: problem
- Uruchomienie uaktualnienia z poziomu lokalnego do skarbca kończy się niepowodzeniem: problem
- Związek między opcjami „create” i „install jx” oraz „boot” i „import”: problem
- Dokumentacja Helm jest rozproszona: problem
- Popraw dokumentację, która wyjaśnia, dlaczego ChartMuseum, Monocular i Docker Registry nie zostaną zastąpione problemem z Nexusem
- Nie można zmienić rejestru Dockera podczas korzystania z Boot + GKE: problem
- Zmiana domeny z nip.io na domenę niestandardową kończy się niepowodzeniem: problem
W przypadku tablicy funkcji Jenkins X praca obejmuje (jak opisano poniżej) dotyczące usług Kubernetes dla przedsiębiorstw oferowanych przez każdego z dostawców Cloud, tj. Google Cloud (GKE), Amazon Web Services (AWS EKS) i Azure Cloud (AKS).
- Instalacja Jenkinsa X w chmurze za pomocą skryptów terraform i
jx boot
- Sprawdzam zgodność wersji Kubernetes z Jennkinsem X w usługach Kubernetes dostawców chmury.
- Inne możliwości (przechowywanie tajemnic w Vault, wersje kontroli źródła lub inne) do omówienia z Deane i członkami społeczności Jenkins X.
W ramach prac nad konfiguracją infrastruktury środowiska podglądu Jenkinsa X na podstawie OpenShift zespół wykonał te zadania:
- Dokument projektowy na temat infrastruktury środowiska w wersji próbnej Jenkinsa X na platformie OpenShift
- Automatyczne tworzenie środowisk podglądu Jenkinsa X w OpenShift
- Aktualizacja dokumentacji Jenkinsa X w środowiskach podglądu
Wyniki projektu:
- Poprawki w PR dotyczące wymienionych powyżej problemów z dokumentacją, z uwzględnieniem refaktoryzacji istniejącej dokumentacji Jenkins X.
- Zaktualizowana tabela możliwości Jenkins X wraz z dokumentacją użytkownika dotyczącą korzystania z Jenkins X w przypadku różnych dostawców usług w chmurze (głównie usługi Kubernetes AKS, EKS i GKE).
- Automatyczne konfigurowanie środowiska w wersji zapoznawczej Jenkinsa X opartego na OpenShift we współpracy z Danielem.
Wstępny harmonogram (wraz z zadaniami):
Społecznościowe więzi (17 sierpnia – 13 września)
- Skonfiguruj środowisko programistyczne na potrzeby dokumentacji technicznej oraz uzyskaj dostęp do infrastruktury Cloud na potrzeby wykonywania zadań projektowych.
- Dyskusja z mentorami projektu na temat proponowanego wstępnego harmonogramu, produktów projektu oraz zadań (wraz z ich priorytetem).
- Dowiedz się więcej o procesach pracy i sprawdzania PR oraz zaangażuj się w działania społeczności.
- Sprawdź bieżący stan dokumentacji Jenkinsa X.
Tydzień 1 (14–20 września)
- Poznaj instrukcje konfigurowania Jenkins X w chmurze, aktualny stan i dokumentację.
- Rozmowa z Deane na temat obecnych możliwości Jenkinsa X (do weryfikacji u różnych dostawców usług w chmurze).
- Rozmowa z Danielem na temat obecnego stanu infrastruktury środowiska w wersji zapoznawczej Jenkinsa X opartej na OpenShift.
- praca (we współpracy z Danielem) nad projektem architektury infrastruktury środowiska podglądu Jenkinsa X w OpenShift;
Tydzień 2 (21–27 września)
- Praca nad matrycą możliwości Jenkinsa X w GKE Cloud: instalacja Jenkinsa X i przygotowanie wersji roboczej notatek dla użytkowników.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
Tydzień 3 (28 września – 4 października)
- Pracuj nad tabelą możliwości Jenkinsa X dla chmury GKE: instalacja Jenkinsa X i przygotowywanie wersji roboczych notatek dla użytkowników.
- Popracuj nad jednym z problemów z dokumentami, aby ulepszyć istniejącą dokumentację Jenkinsa X.
- Praca nad dokumentem projektowym infrastruktury środowiska w wersji zapoznawczej Jenkinsa X na podstawie OpenShift.
Tydzień 4 (5–11 października)
- Dokończ dokumentację użytkownika Jenkinsa X w GKE.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
Tydzień 5 (12 października – 18 października)
- Praca nad matrycą możliwości Jenkinsa X w chmurze Azure (AKS): instalacja Jenkinsa X i przygotowanie wersji roboczej notatek dla użytkowników.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
- Po otrzymaniu opinii od członków społeczności ostatecznie opracuj dokument projektowy infrastruktury środowiska w wersji próbnej Jenkins X na podstawie OpenShift.
Tydzień 6 (19–25 października)
- Praca nad matrycą możliwości Jenkinsa X w chmurze Azure (AKS): instalacja Jenkinsa X i przygotowanie wersji roboczej notatek dla użytkowników.
- Popracuj nad jednym z problemów z dokumentami, aby ulepszyć istniejącą dokumentację Jenkinsa X.
Tydzień 7 (26 paź – 1 lis)
- Praca nad matrycą możliwości Jenkinsa X w chmurze Azure (AKS): instalacja Jenkinsa X i przygotowanie wersji roboczej notatek dla użytkowników.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
- Praca nad konfigurowaniem infrastruktury środowiska preview Jenkinsa X na podstawie OpenShift.
Tydzień 8 (2–8 listopada)
- Dokończ dokumentację użytkownika Jenkinsa X na AKS.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
Tydzień 9 (9–15 listopada)
- Przygotuj macierz funkcji Jenkinsa X dla AWS (EKS): instalacja Jenkinsa X i przygotowanie wersji roboczych notatek dla użytkowników.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
- Pracuj nad konfiguracją infrastruktury środowiska podglądu Jenkins X opartego na OpenShift.
Tydzień 10 (16–22 listopada)
- Przygotuj macierz funkcji Jenkinsa X dla AWS (EKS): instalacja Jenkinsa X i przygotowanie wersji roboczych notatek dla użytkowników.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
Tydzień 11 (23–29 listopada)
- Sfinalizuj dokumentację użytkownika Jenkins X w EKS.
- Praca nad jednym z problemów z dokumentacją w celu ulepszenia istniejącej dokumentacji Jenkins X.
- Dokończyć dokumentację infrastruktury środowiska w wersji zapoznawczej Jenkinsa X na stronie z dokumentacją Jenkinsa X.
Tydzień 12 (30 listopada – 5 grudnia)
- Na podstawie opinii ostatecznie przygotuj wyniki projektu i w razie potrzeby przerzuć kod.
- Testowanie działania witryny z dokumentacją Jenkinsa X, w tym linków, obrazów, hiperlinków i innych elementów.
- Sprawdź, czy na stronie dokumentacji Jenkinsa X są dostępne elementy sterujące i nawigacja zdefiniowane przez użytkownika.
- Zobacz ostateczną prezentację macierzy Jenkins X Capabilites.
Przed 10 grudnia 2020 r. Ocena projektu jest przesyłana przez autora technicznego i mentorów.
Jakie korzyści przyniesie proponowany projekt dla Jenkins X i jego społeczności? Ten projekt pomoże społeczności Jenkins X ulepszyć dokumentację dla użytkowników końcowych oraz dla deweloperów, którzy potrzebują informacji na temat architektury technicznej, zgodności, użycia i integracji Jenkinsa X. Po zakończeniu tego proponowanego projektu powstanie pełna, dobrze zdefiniowana i technicznie zweryfikowana dokumentacja użytkownika Jenkinsa X oraz tabela możliwości Jenkinsa X, która umożliwi jego zgodność z różnymi dostawcami usług w chmurze.
Jakie przyszłe korzyści planujesz uzyskać dzięki Jenkins X? Po zakończeniu programu Google Season of Docs 2020 planuję stać się długoterminowym współtwórcą projektu Jenkins X jako aktywny członek społeczności. Zawsze będę pomagać innym (nowicjuszom) i zachęcać ich do zaangażowania się w społeczność Jenkinsa X. Zawsze chętnie podejmę się innych projektów Jenkins X.
Oto kilka powodów, dla których uważam, że jestem odpowiednią osobą do pracy nad tym projektem:
- Jestem bardzo metodyczna i zorganizowana. Oczekuję, że postępy projektu będą regularnie informowane zarówno mentorom, jak i społeczności organizacji za pomocą postów na blogu raz w tygodniu, zaplanowanych cotygodniowych spotkań w dokumentach SIG oraz e-maili.
- Będzie regularnie uzyskiwać wskazówki oraz opinie od mentorów i członków społeczności, aby kontynuować wykonywanie zadań i dbać o to, żeby wszyscy byli na tym samym miejscu (obejmuje to także wzmianki o wszelkich wyzwaniach i problemach, z jakimi się borykają).
- regularne skomitowanie całego napisanego kodu źródłowego, aby mentor i współtwórcy mogli go sprawdzić, a także udokumentowanie wykonanej pracy na potrzeby członków społeczności;
- Mam wszystkie umiejętności techniczne wymagane do pracy nad tym projektem i omówiłem propozycję projektu z mentorami Deane, Karą i Danielem. Dobrze znam już propozycję projektu i jego możliwe do dostarczenia.
- Mam doświadczenie w pracy z umiejętnościami technicznymi (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo i inne), które są potrzebne do tworzenia pełnej dokumentacji oraz rozwiązywania większości obecnych problemów związanych z dokumentacją. Jestem osobą pozytywnie nastawioną, która potrafi wykonać projekt w terminie bez większego nadzoru.