Progetto Jenkins X

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

Riepilogo del progetto

Organizzazione open source:
Jenkins X
Redattore tecnico:
Nitin
Nome del progetto:
Rifactorizzazione del sito di documentazione esistente 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 è eseguire il refactoring della documentazione esistente di Jenkins X, correggere i problemi relativi alla documentazione e preparare la matrice delle funzionalità di Jenkins X aggiornata insieme alla documentazione utente sull'utilizzo di Jenkins X sui provider cloud aziendali. Inoltre, questo progetto prevede lo 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 lavorerò includono:

  • Avvio nelle risorse EKS: problema
  • Vault non riesce in EKS con Boot: Issue
  • Documenta le variabili d'ambiente per l'avvio di jx: problema
  • Documentazione richiesta per la configurazione di Vault: problema
  • L'upgrade del boot da locale a Vault non riesce: problema
  • Feedback sulla documentazione Relazione tra "create", "install jx", "boot" e "import": problema
  • La documentazione di Helm è sparsa: problema
  • Migliora i documenti perché ChartMuseum, Monocular e Docker Registry non vengono sostituiti con un problema relativo a Nexus
  • Impossibile modificare il registry Docker quando si utilizza Boot + GKE: problema
  • La modifica del dominio da nip.io a un dominio personalizzato non va a buon fine: problema

Per quanto riguarda 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
  • Verificare la compatibilità delle versioni di Kubernetes con Jenkins X sui servizi Kubernetes di questi provider cloud.
  • Qualsiasi altra funzionalità (archiviazione di Vault per i secret, le 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 basata su OpenShift, il lavoro include:

  • Documento di progettazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X sulla piattaforma OpenShift
  • Automatizzare la creazione di ambienti di anteprima di Jenkins X in OpenShift
  • Aggiornare la documentazione di Jenkins X negli ambienti di anteprima

Risultati del progetto:

  • Correzioni tramite PR ai problemi relativi alla documentazione sopra indicati, in considerazione del refactoring della documentazione esistente di Jenkins X.
  • È stato aggiornato Jenkins X Capabilities Matrix insieme alla documentazione utente 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 basata su OpenShift, in collaborazione con Daniel.

Cronologia provvisoria (insieme alle attività) proposte:

Legame con la comunità (17 ago - 13 set)

  • Configura l'ambiente di sviluppo per la documentazione tecnica e accedi alle infrastrutture Cloud per lavorare alle attività del progetto.
  • Discussione con i mentori del progetto sulle tempistiche previste proposte, sui risultati finali del progetto e sulle attività (insieme alla loro priorità).
  • Comprendi e acquisisci le competenze necessarie per conoscere il processo di lavoro dell'organizzazione, la procedura di revisione delle pubbliche relazioni e partecipa alla community.
  • Esamina lo stato attuale della documentazione di Jenkins X.

Settimana 1 (14-20 settembre)

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

Settimana 2 (21-27 settembre)

  • Lavora alla matrice delle funzionalità di Jenkins X per il cloud GKE: installazione di Jenkins X e preparazione della bozza delle note per gli utenti.
  • Lavora a uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 3 (28 set - 4 ott)

  • Lavora alla matrice delle funzionalità di Jenkins X per il cloud GKE: installazione di Jenkins X e preparazione della bozza delle note per gli utenti.
  • Lavora a uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.
  • Lavora al documento di progettazione per l'infrastruttura dell'ambiente di anteprima di Jenkins X basata su OpenShift.

Settimana 4 (5-11 ott)

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

Settimana 5 (12-18 ottobre)

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

Settimana 6 (19-25 ottobre)

  • Lavora alla matrice delle funzionalità di Jenkins X per il cloud Azure (AKS): installazione di Jenkins X e prepara la bozza delle note dell'utente.
  • Lavora a uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 7 (26 ott - 1 nov)

  • Lavora alla matrice delle funzionalità di Jenkins X per il cloud Azure (AKS): installazione di Jenkins X e preparazione della bozza delle note per gli utenti.
  • Lavora a uno dei problemi legati ai documenti per migliorare la documentazione esistente di Jenkins X.
  • Lavora alla configurazione dell'infrastruttura dell'ambiente di anteprima di Jenkins X basata su OpenShift.

Settimana 8 (2-8 nov)

  • Finalizza la documentazione utente per Jenkins X su AKS.
  • Lavora a uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 9 (9-15 nov)

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

Settimana 10 (16-22 nov)

  • Lavora sulla matrice delle funzionalità di Jenkins X per AWS (EKS): installazione di Jenkins X e prepara la bozza delle note per gli utenti.
  • Lavora a uno dei problemi relativi alla documentazione per migliorare la documentazione esistente di Jenkins X.

Settimana 11 (23 nov - 29 nov)

  • Completa la documentazione utente per Jenkins X su EKS.
  • Lavora a 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 di documentazione di Jenkins X.

Settimana 12 (30 nov - 5 dic)

  • Finalizza i deliverable del progetto e, se necessario, esegui il refactoring del codice in base al feedback.
  • Verifica il funzionamento del sito di Documenti di Jenkins X, compresi link, immagini, link ipertestuali e altro.
  • Controlla il controllo e la navigazione definiti dall'utente del sito della documentazione di Jenkins X.
  • Controlla la presentazione definitiva della matrice delle funzionalità di Jenkins X.

Prima del 10 dicembre 2020 Il Technical Writer e i mentori inviano la valutazione del progetto.

Quali vantaggi offre il progetto proposto a Jenkins X e alla sua community? Questo progetto aiuterà la community di Jenkins X a migliorare la documentazione per gli utenti finali e gli sviluppatori come riferimento per l'architettura tecnica, la compatibilità, l'utilizzo e l'integrazione di Jenkins X. Una volta completato il progetto proposto, sarebbe quindi disponibile una documentazione per l'utente completa, ben definita e tecnicamente verificata di Jenkins X insieme a Jenkins X Capability Matrix per la sua compatibilità con diversi cloud provider.

Quali vantaggi futuri prevedi di sfruttare con Jenkins X? Dopo la fine del programma Google Season of Docs 2020, ho intenzione di diventare un collaboratore a lungo termine del progetto Jenkins X come membro attivo della community. Sarò sempre disponibile per aiutare gli altri (nuovi arrivati) e incoraggiarli a entrare a far parte della community di Jenkins X. Sarò sempre disponibile a lavorare su altre idee di progetti Jenkins X.

Ecco alcuni dei motivi per cui sono la persona più adatta a lavorare a questo progetto:

  • Sono molto metodico e organizzato. Mi aspetto di aggiornare regolarmente i mentor del progetto e la community dell'organizzazione sull'avanzamento del progetto tramite post del blog una volta alla settimana, riunioni settimanali pianificate dei SIG-docs e via email.
  • Dovrà chiedere spesso indicazioni e feedback ai mentor e ai membri della community, in modo da procedere con le attività e assicurarsi che tutti siano d'accordo (incluse eventuali difficoltà e/o punti di blocco riscontrati).
  • Esegui il commit di tutto il codice sorgente scritto regolarmente, in modo da far esaminare il codice dal mentore e dai collaboratori, nonché documentare il lavoro svolto per riferimento ai membri della community.
  • Ho tutte le competenze tecniche richieste per lavorare a questa idea di progetto e ho discusso la proposta con i mentori Deane, Kara e Daniel. Ho una conoscenza approfondita della proposta di progetto e dei relativi risultati.
  • Ho esperienza nell'utilizzo delle competenze tecniche (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo e altre) necessarie per fornire una documentazione completa e risolvere la maggior parte dei problemi attuali relativi alla documentazione. Ho un atteggiamento positivo perché riesce a portare a termine il progetto in tempo con poca supervisione.