Progetto Jenkins X

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:
Jenkins X
Technical writer:
Nitin
Nome progetto:
Refactoring del sito di documenti Jenkins X esistente e della matrice delle funzionalità di Jenkins X
Durata del progetto:
Durata standard (3 mesi)

Project description

L'obiettivo principale di questo progetto è il refactoring della documentazione esistente di Jenkins X e la risoluzione dei problemi relativi ai documenti, nonché la preparazione della matrice delle funzionalità aggiornata di Jenkins X insieme alla documentazione per gli utenti sull'utilizzo di Jenkins X nei cloud provider aziendali. Inoltre, questo progetto prevede anche il lavoro sullo sviluppo dell'infrastruttura dell'ambiente di anteprima di Jenkins X basata su OpenShift, in collaborazione con Daniel.

Nell'ambito del refactoring della documentazione esistente di Jenkins X, alcuni dei problemi su cui avrei lavorato includono:

  • Avvio nelle risorse EKS: problema
  • Errore di Vault in EKS con avvio: problema
  • Documenti envars per avvio jx: problema
  • Documentazione necessaria per la configurazione di Vault: problema
  • Upgrade dell'avvio da locale a Vault non riuscito: problema
  • Feedback sulla documentazione - Rapporto tra "create" e "install jx" rispetto a "boot" e "import": problema
  • La documentazione di Helm è ovunque: problema
  • Migliora la documentazione perché ChartMuseum, Monocular e Docker Registry non vengono sostituiti con Nexus Issue
  • Impossibile modificare Docker Registry quando si utilizza Boot + GKE: problema
  • La modifica del dominio da nip.io a un dominio personalizzato non va a buon fine: problema

Per la matrice delle funzionalità di Jenkins X, il lavoro riguarda (come menzionato di seguito) i servizi Kubernetes aziendali offerti da ciascuno dei cloud provider, ovvero Google Cloud (GKE), Amazon Web Services (AWS EKS) e Azure Cloud (AKS).

  • Installazione di Jenkins X sul cloud tramite script Terraform e jx boot
  • È in corso la verifica della compatibilità delle versioni di Kubernetes con Jenkins X su questi servizi Kubernetes dei cloud provider.
  • Qualsiasi altra funzionalità (archiviazione Vault per secret, versioni per il controllo del codice sorgente o altro) da discutere con Deane e i membri della community di Jenkins X.

Per quanto riguarda la configurazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X basata su OpenShift, il lavoro include:

  • Progetta un documento sull'infrastruttura dell'ambiente di anteprima di Jenkins X sulla piattaforma OpenShift
  • Automatizza la creazione di ambienti di anteprima di Jenkins X in OpenShift
  • Aggiornare la documentazione per Jenkins X sugli ambienti di anteprima

Risultati del progetto:

  • Correzioni tramite PR dei problemi relativi ai documenti sopra menzionati, in considerazione del refactoring della documentazione esistente di Jenkins X.
  • È stata aggiornata la matrice delle funzionalità di Jenkins X insieme alla documentazione per gli utenti sull'utilizzo di Jenkins X con diversi cloud provider (servizi Kubernetes principalmente AKS, EKS e GKE).
  • Configurazione automatica dell'infrastruttura dell'ambiente di anteprima di Jenkins X su OpenShift, in collaborazione con Daniel.

Sequenza temporale provvisoria (insieme alle attività) proposta:

Legami della community (17 agosto - 13 settembre)

  • Configura l'ambiente di sviluppo per la documentazione tecnica e ottieni l'accesso alle infrastrutture Cloud per lavorare alle attività del progetto.
  • Discussione con i mentori del progetto sulla tempistica provvisoria proposta, sui risultati finali del progetto e sulle attività (insieme alle priorità).
  • Comprendi e acquisisci le competenze necessarie per il processo di lavoro e di revisione delle pubbliche relazioni dell'organizzazione e interagisci con la comunità.
  • Esamina lo stato attuale della documentazione di Jenkins X.

Settimana 1 (14 - 20 settembre)

  • Comprendi le istruzioni per la configurazione di Jenkins X sul cloud, sullo stato attuale e nella documentazione.
  • Discussione con Deane sulle attuali funzionalità di Jenkins X (da verificare su diversi cloud provider).
  • Discussione con Daniel sullo stato attuale dell'infrastruttura dell'ambiente di anteprima di Jenkins X basata su OpenShift.
  • Collabora con Daniele per progettare l'architettura dell'infrastruttura dell'ambiente di anteprima di Jenkins X su OpenShift.

Settimana 2 (21 settembre - 27 settembre)

  • Lavora sulla matrice delle funzionalità di Jenkins X per il cloud di GKE: installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.

Settimana 3 (28 settembre - 4 ott)

  • Lavora sulla matrice delle funzionalità di Jenkins X per il cloud di GKE: installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.
  • Lavorare sull'infrastruttura dell'ambiente di anteprima di Jenkins X per il documento di progettazione basato su OpenShift.

Settimana 4 (5 - 11 ott)

  • Finalizza la documentazione per gli utenti di Jenkins X su GKE.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.

Settimana 5 (12 - 18 ott)

  • Lavora sulla matrice delle funzionalità di Jenkins X per il cloud Azure (AKS): installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.
  • Finalizza il documento di progettazione per l'infrastruttura dell'ambiente di anteprima di Jenkins X basato su OpenShift, dopo aver ricevuto il feedback dai membri della community.

Settimana 6 (19 - 25 ott)

  • Lavora sulla matrice delle funzionalità di Jenkins X per il cloud Azure (AKS): installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.

Settimana 7 (26 ott - 1 nov)

  • Lavora sulla matrice delle funzionalità di Jenkins X per il cloud Azure (AKS): installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.
  • Lavora sulla configurazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X in base a OpenShift.

Settimana 8 (2 nov - 8 nov)

  • Finalizza la documentazione per gli utenti di Jenkins X su AKS.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.

Settimana 9 (9 - 15 nov)

  • Lavora sulla matrice delle funzionalità di Jenkins X per AWS (EKS): installazione di Jenkins X e preparazione delle bozze delle note per gli utenti.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.
  • Lavora sulla configurazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X in base a OpenShift.

Settimana 10 (16 - 22 nov)

  • Lavora sulla matrice delle funzionalità di Jenkins X per AWS (EKS): installazione di Jenkins X e preparazione delle bozze delle note per gli utenti.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.

Settimana 11 (23 - 29 nov)

  • Finalizza la documentazione per gli utenti di Jenkins X su EKS.
  • Lavora su uno dei problemi con i documenti per migliorare la documentazione esistente di Jenkins X.
  • Finalizza la documentazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X sul sito della documentazione di Jenkins X.

Settimana 12 (30 nov - 5 dic)

  • Finalizza i risultati finali del progetto ed eventualmente esegui il refactoring del codice in base al feedback.
  • Verifica il funzionamento del sito di documenti di Jenkins X, inclusi link, immagini, link ipertestuali e altro ancora.
  • Verifica il controllo definito dall'utente e la navigazione nel sito della documentazione di Jenkins X.
  • Controlla la presentazione finale della matrice Jenkins X Capabilites.

Prima del 10 dicembre 2020 Sia il Technical Writer che i Mentori inviano la valutazione del progetto.

Quali vantaggi offre il progetto proposto per Jenkins X e per la sua community? Questo progetto aiuterà la community di Jenkins X a migliorare la documentazione per i suoi utenti finali e per gli sviluppatori per riferimento su architettura tecnica, compatibilità, utilizzo e integrazione di Jenkins X. Con il completamento di questo progetto proposto, sarebbe quindi disponibile una documentazione utente completa, ben definita e tecnicamente verificata di Jenkins X insieme alla matrice delle capacità di Jenkins X per la sua compatibilità con diversi cloud provider.

A quali vantaggi per il futuro hai intenzione di lavorare con Jenkins X? Dopo la fine del programma Google Season of Docs 2020, in qualità di membro attivo della community ho intenzione di contribuire a lungo termine al progetto Jenkins X. Sarò sempre presente per aiutare gli altri (nuovi arrivati) e incoraggiarli a partecipare alla community di Jenkins X. Sarei sempre disponibile a lavorare su altre idee per i progetti di Jenkins X.

Ecco alcuni dei motivi che mi rendono più adatto a lavorare a questo progetto:

  • Sono molto metodica e organizzata. Mi aspetto fortemente di tenerti informato sullo stato di avanzamento del progetto sia ai mentori del progetto che alla community dell'organizzazione tramite post del blog una volta alla settimana, riunioni settimanali con i documenti SIG e regolarmente via email.
  • Cercherò spesso consigli e feedback da parte dei mentori e dei membri della community, in modo da portare avanti le attività e garantire che tutti siano d'accordo (menzionando inclusivamente le sfide e/o i punti di blocco riscontrati).
  • Impegnando tutto il codice sorgente scritto regolarmente, in modo da far esaminare il codice da parte del tutor, dei collaboratori e documentare il lavoro svolto per riferimento ai membri della community.
  • Ho tutte le competenze tecniche necessarie per lavorare a questa idea di progetto e ho discusso della proposta di progetto con i mentori Deane, Kara e Daniel. Ho una comprensione approfondita della proposta del progetto e dei suoi risultati finali.
  • Ho esperienza di lavoro con le competenze tecniche (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo e altre) necessarie per fornire una documentazione completa e risolvere la maggior parte degli attuali problemi relativi alla documentazione. Ho l'atteggiamento positivo che riesce a portare a termine il lavoro sul progetto in tempo senza supervisione.