Projet Jenkins X

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:
Jenkins X
Rédacteur technique:
Nitin
Nom du projet:
Refactorisation du site de documentation Jenkins X existant et de la matrice des fonctionnalités de Jenkins X
Durée du projet:
Durée standard (3 mois)

Project description

L'objectif principal de ce projet est de refactoriser la documentation existante de Jenkins X tout en corrigeant les problèmes associés. Il prépare également la nouvelle matrice des fonctionnalités de Jenkins X, ainsi que la documentation utilisateur sur l'utilisation de Jenkins X auprès des fournisseurs de services cloud d'entreprise. Ce projet implique également de travailler sur le développement de l'infrastructure d'environnement d'aperçu Jenkins X basée sur OpenShift, en collaboration avec Daniel.

Voici quelques-uns des problèmes que je pourrais résoudre dans le cadre de la refactorisation de la documentation existante de Jenkins X:

  • Démarrage dans les ressources EKS: problème
  • Échec de Vault dans EKS lors du démarrage: problème
  • Envars de document pour jx boot: problème
  • Documentation requise pour la configuration de Vault: problème
  • Échec du démarrage de la mise à niveau du stockage local vers le coffre-fort: problème
  • Commentaires sur la documentation Relation entre "create", "install jx", "boot" et "import" : problème
  • La documentation Helm est partout: problème
  • Amélioration de la documentation expliquant pourquoi ChartMuseum, Monocular et Docker Registry ne sont pas remplacés par un problème lié à Nexus.
  • Impossible de modifier le registre Docker lors de l'utilisation du démarrage et de GKE: problème
  • Échec du remplacement du domaine nip.io par un domaine personnalisé: problème

Pour la matrice des fonctionnalités de Jenkins X, le travail implique (comme mentionné ci-dessous) les services d'entreprise Kubernetes proposés par chacun des fournisseurs cloud, à savoir, Google Cloud (GKE), Amazon Web Services (AWS EKS) et Azure Cloud (AKS).

  • Installation de Jenkins X dans le cloud via des scripts Terraform et jx boot
  • Vérification de la compatibilité des versions de Kubernetes avec Jenkins X sur les services Kubernetes de ces fournisseurs cloud
  • Toute autre fonctionnalité (stockage Vault pour les secrets, versions de contrôle des sources, etc.) à discuter avec Deane et les membres de la communauté Jenkins X.

En ce qui concerne la configuration de l'infrastructure de l'environnement d'aperçu Jenkins X basée sur OpenShift, votre travail comprend les tâches suivantes:

  • Document de conception sur Jenkins X (aperçu de l'infrastructure de l'environnement sur la plate-forme OpenShift)
  • Automatiser la création d'environnements d'aperçu Jenkins X dans OpenShift
  • Mettre à jour la documentation de Jenkins X sur les environnements d'aperçu

Produits livrables du projet:

  • Correction des problèmes de documentation mentionnés ci-dessus via PR, en tenant compte de la documentation existante de Jenkins X.
  • Mise à jour de la matrice des fonctionnalités de Jenkins X, ainsi que de la documentation utilisateur sur l'utilisation de Jenkins X avec différents fournisseurs de services cloud (services Kubernetes principalement AKS, EKS et GKE)
  • Configuration automatisée de l'infrastructure d'aperçu de Jenkins X basée sur OpenShift, en collaboration avec Daniel.

Calendrier provisoire (ainsi que les tâches) proposé:

Engagement communautaire (17 août-13 sept.)

  • Configurer l'environnement de développement pour la documentation technique et accéder aux infrastructures cloud pour travailler sur les tâches du projet
  • Discussion avec les mentors du projet sur le calendrier provisoire proposé, les produits livrables du projet ainsi que les tâches (ainsi que leur priorité).
  • Comprendre le processus de travail de l'organisation et le processus d'examen des relations publiques, et vous familiariser avec ce processus, et vous impliquer dans la communauté.
  • Examiner l'état actuel de la documentation Jenkins X

Semaine 1 (14 sept. - 20 sept.)

  • Découvrez les instructions de configuration de Jenkins X sur le cloud, son état actuel et sa documentation.
  • Discussion avec Deane sur les fonctionnalités actuelles de Jenkins X (à valider auprès de différents fournisseurs de services cloud).
  • Discussion avec Daniel sur l'état actuel de l'infrastructure de l'environnement d'aperçu Jenkins X basée sur OpenShift.
  • Travailler (en collaboration avec Daniel) pour concevoir l'architecture de l'infrastructure d'environnement Jenkins X sur OpenShift

Semaine 2 (21 sept. - 27 sept.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour le cloud GKE: installation de Jenkins X et préparation des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.

Semaine 3 (28 sept. - 4 oct.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour le cloud GKE: installation de Jenkins X et préparation des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.
  • Travaillez sur le document de conception de l'infrastructure de l'environnement de prévisualisation de Jenkins X basée sur OpenShift.

Semaine 4 (5 oct. - 11 oct.)

  • Finaliser la documentation utilisateur pour Jenkins X sur GKE
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.

Semaine 5 (12 oct. - 18 oct.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour le cloud Azure (AKS): installer Jenkins X et préparer des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.
  • Finaliser le document de conception de l'infrastructure d'aperçu de Jenkins X basée sur OpenShift après avoir recueilli les commentaires des membres de la communauté

Semaine 6 (19 oct. - 25 oct.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour le cloud Azure (AKS): installer Jenkins X et préparer des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.

Semaine 7 (26 oct. - 1er nov.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour le cloud Azure (AKS): installer Jenkins X et préparer des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.
  • Configurer l'infrastructure de l'environnement d'aperçu Jenkins X basé sur OpenShift

Semaine 8 (2 nov. – 8 nov.)

  • Finaliser la documentation utilisateur pour Jenkins X sur AKS
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.

Semaine 9 (9 nov. – 15 nov.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour AWS (EKS): installer Jenkins X et préparer des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.
  • Configurer l'infrastructure de l'environnement d'aperçu Jenkins X basé sur OpenShift

Semaine 10 (16 nov. - 22 nov.)

  • Travailler sur la matrice des fonctionnalités Jenkins X pour AWS (EKS): installer Jenkins X et préparer des brouillons de notes utilisateur
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.

Semaine 11 (23 nov. - 29 nov.)

  • Finaliser la documentation utilisateur pour Jenkins X sur EKS
  • Travaillez sur l'un des problèmes liés à la documentation pour améliorer la documentation existante de Jenkins X.
  • Finaliser la documentation de l'infrastructure de l'environnement d'aperçu Jenkins X sur le site de documentation de Jenkins X

Semaine 12 (30 nov. - 5 déc.)

  • Finaliser les produits livrables du projet et refactoriser le code le cas échéant, en fonction des commentaires.
  • Testez le fonctionnement du site de documentation Jenkins X, y compris les liens, images, liens hypertexte et autres.
  • Vérifiez les commandes définies par l'utilisateur et la navigation sur le site de documentation de Jenkins X.
  • Consultez la présentation finalisée de la matrice des fonctionnalités de Jenkins X.

Avant le 10 décembre 2020 Les rédacteurs techniques et les parrains soumettent l'évaluation du projet.

Quels sont les avantages du projet proposé pour Jenkins X et sa communauté ? Ce projet permettra à la communauté Jenkins X d'améliorer la documentation destinée aux utilisateurs finaux et aux développeurs sur l'architecture technique, la compatibilité, l'utilisation et l'intégration de Jenkins X. Une fois ce projet achevé, il serait possible de disposer d'une documentation utilisateur complète, bien définie et techniquement validée sur Jenkins X, ainsi que de la matrice des fonctionnalités Jenkins X pour sa compatibilité avec les différents fournisseurs de services cloud.

À l'avenir, quels avantages prévoyez-vous de travailler avec Jenkins X ? Après la fin du programme Google Season of Docs 2020, j'ai l'intention de contribuer à long terme au projet Jenkins X en tant que membre actif de la communauté. Je serai toujours là pour aider les autres (nouveaux arrivants) et les encourager à s'impliquer dans la communauté Jenkins X. Je serais toujours prête à travailler sur d'autres idées de projets Jenkins X.

Voici quelques-unes des raisons qui me rendent le mieux adapté pour travailler sur ce projet:

  • Je suis très méthodique et organisé. Je m'attends à être tenu informé de l'avancement du projet auprès des mentors du projet et de la communauté de l'organisation via des articles de blog une fois par semaine, des réunions hebdomadaires de SIG-docs et des e-mails régulièrement.
  • recherchera fréquemment des conseils ainsi que les commentaires des mentors et des membres de la communauté, afin de progresser dans les tâches et de s'assurer que tout le monde soit sur la même longueur d'onde (mentionnant de manière inclusive les difficultés et/ou les points de blocage rencontrés).
  • Vous vous engagez à rédiger régulièrement tout le code source, afin que le code soit examiné par le mentor et les contributeurs, et en documentant le travail effectué pour référence aux membres de la communauté.
  • J'ai toutes les compétences techniques requises pour travailler sur cette idée de projet et j'ai discuté de la proposition de projet avec les mentors Deane, Kara et Daniel. J'ai une compréhension approfondie de la proposition de projet et de ses produits livrables.
  • J'ai l'expérience des compétences techniques (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo, etc.) nécessaires pour fournir une documentation complète et résoudre la plupart des problèmes actuels liés à la documentation. J'ai une attitude positive qui peut faire et terminer le projet à temps avec peu de supervision.