Progetto Jenkins X

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.

Riepilogo del progetto

Organizzazione open source:
Jenkins X
Technical writer:
Nitin
Nome progetto:
Refactoring del sito esistente di documenti di Jenkins X 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 mentre risolvi i problemi relativi alla documentazione, nonché la preparazione della matrice aggiornata delle funzionalità di Jenkins X insieme alla documentazione per gli utenti sull'utilizzo di Jenkins X nei cloud provider aziendali. Inoltre, questo progetto comporta anche lo sviluppo dell'infrastruttura dell'ambiente di anteprima di Jenkins X basato 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
  • Vault si arresta in EKS con avvio: problema
  • Documenti envar per l'avvio jx: problema
  • Documentazione necessaria per la configurazione di Vault: problema
  • Upgrade dell'avvio da locale a Vault non riuscito: problema
  • Feedback sulla documentazione Relazione tra "create" e "install jx" rispetto a "boot" e "import": problema
  • La documentazione di Helm è dappertutto: problema
  • Migliora la documentazione perché ChartMuseum, Monocular e Docker Registry non vengono sostituiti con Nexus Issue
  • Impossibile modificare il Docker Registry durante l'utilizzo di Boot + GKE: problema
  • Modifica del dominio da nip.io a un dominio personalizzato non riuscita: problema

Per la matrice delle funzionalità di Jenkins X, il lavoro riguarda (come indicato 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
  • Controllo della compatibilità delle versioni di Kubernetes con Jenkins X su questi servizi Kubernetes dei cloud provider.
  • Qualsiasi altra funzionalità (archiviazione di Vault per secret, versioni di controllo del codice sorgente o altro) da discutere con Deane e i membri della community di Jenkins X.

Per quanto riguarda il lavoro di configurazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X basato 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
  • Aggiorna la documentazione di Jenkins X sugli ambienti di anteprima

Risultati del progetto:

  • Correzioni tramite PR ai 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'ambiente di anteprima di Jenkins X per l'infrastruttura basata su OpenShift, in collaborazione con Daniel.

Sequenza temporale provvisoria (insieme alle attività) proposta:

Bonding 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 i requisiti per il processo di lavoro dell'organizzazione e il processo di revisione delle pubbliche relazioni ed entra in contatto con la comunità.
  • Esamina lo stato attuale della documentazione di Jenkins X.

Settimana 1 (14 set - 20 set)

  • Comprendi le istruzioni per la configurazione di Jenkins X sul cloud, sullo stato attuale e sulla documentazione.
  • Discussione con Deane sulle funzionalità attuali 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 (in collaborazione con Daniele) alla progettazione dell'architettura per l'infrastruttura dell'ambiente di anteprima di Jenkins X su OpenShift.

Settimana 2 (21 set - 27 set)

  • Lavora sulla matrice di funzionalità di Jenkins X per il cloud GKE: installazione di Jenkins X e preparazione di note per l'utente in bozza.
  • Lavora su uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 3 (28 set - 4 ott)

  • Lavora sulla matrice di funzionalità di Jenkins X per il cloud GKE: installazione di Jenkins X e preparazione di note per l'utente in bozza.
  • Lavora su uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.
  • Lavora all'infrastruttura dell'ambiente di anteprima di Design Document per Jenkins X basato su OpenShift.

Settimana 4 (5 ott - 11 ott)

  • Finalizza la documentazione per gli utenti di Jenkins X su GKE.
  • Lavora su uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 5 (12 ott - 18 ott)

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

Settimana 6 (19 ott - 25 ott)

  • Lavora sulla matrice di funzionalità di Jenkins X per il cloud di Azure (AKS): installazione di Jenkins X e preparazione delle bozze delle note per gli utenti.
  • Lavora su uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 7 (26 ott - 1 nov)

  • Lavora sulla matrice di funzionalità di Jenkins X per il cloud di Azure (AKS): installazione di Jenkins X e preparazione delle bozze delle note per gli utenti.
  • Lavora su uno dei problemi relativi alla documentazione 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 degli utenti per Jenkins X su AKS.
  • Lavora su uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 9 (9 nov - 15 nov)

  • Lavoro sulla matrice di funzionalità di Jenkins X per AWS (EKS): installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi relativi alla documentazione 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 nov - 22 nov)

  • Lavoro sulla matrice di funzionalità di Jenkins X per AWS (EKS): installazione di Jenkins X e preparazione delle bozze delle note per l'utente.
  • Lavora su uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 11 (23 - 29 nov)

  • Finalizza la documentazione degli utenti per Jenkins X su EKS.
  • Lavora su uno dei problemi relativi alla documentazione 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)

  • Finalizzare i risultati finali del progetto ed eventualmente eseguire 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.
  • Verifica il controllo e la navigazione definiti dall'utente nel sito dei documenti di Jenkins X.
  • Controlla la presentazione finale della matrice delle funzionalità di Jenkins X.

Prima del 10 dicembre 2020 Sia il Technical Writer che i Mentor inviano una 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 gli utenti finali e gli sviluppatori per riferimento su architettura tecnica, compatibilità, utilizzo e integrazione di Jenkins X. Una volta completato questo progetto proposto, ci sarebbe quindi una documentazione completa, ben definita e tecnicamente verificata per l'utente di Jenkins X insieme alla matrice delle capacità di Jenkins X per la sua compatibilità con diversi cloud provider.

Su quali vantaggi in futuro prevedi di lavorare con Jenkins X? In qualità di membro attivo della community, dopo la fine del programma Google Season of Docs 2020, ho intenzione di contribuire a lungo termine al progetto Jenkins X. Sarò sempre a disposizione 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 di essere sempre al corrente dello stato di avanzamento del progetto sia ai mentori del progetto sia alla community dell'organizzazione tramite post del blog una volta alla settimana, riunioni settimanali con i documenti SIG e regolarmente via email.
  • Cercherà spesso una guida e un feedback da parte dei mentori e dei membri della community per progredire con le attività e garantire che tutti siano al corrente (menzionando eventuali sfide e/o punti di blocco riscontrati).
  • Impegnando regolarmente tutto il codice sorgente scritto, in modo da far esaminare il codice dal mentore e dai 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 con i mentori Deane, Kara e Daniel. Ho una comprensione approfondita della proposta del progetto e dei relativi risultati.
  • Ho esperienza 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 del progetto in tempo senza supervisione.