Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- Jenkins X
- Rédacteur technique:
- Nitin
- Nom du projet:
- Réfactorisation du site de documentation Jenkins X existant et de la matrice des fonctionnalités Jenkins X
- Durée du projet:
- Durée standard (trois mois)
Project description
L'objectif principal de ce projet est de refactoriser la documentation Jenkins X existante tout en corrigeant les problèmes liés à la documentation, et de préparer la mise à jour de la matrice des fonctionnalités Jenkins X ainsi que la documentation utilisateur sur l'utilisation de Jenkins X sur les fournisseurs de cloud d'entreprise. En outre, ce projet implique de travailler sur le développement de l'infrastructure de l'environnement preview de Jenkins X basée sur OpenShift, en collaboration avec Daniel.
Dans le cadre du refactoring de la documentation Jenkins X existante, voici quelques-uns des problèmes sur lesquels je vais travailler:
- Démarrage dans les ressources EKS: problème
- Échec de Vault dans EKS avec Boot: problème
- Documenter les variables d'environnement pour le démarrage jx: problème
- Documentation nécessaire pour la configuration de Vault: problème
- Échec de la mise à niveau de démarrage de l'environnement local vers le vault: 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 des documents expliquant pourquoi ChartMuseum, Monocular et Docker Registry ne sont pas remplacés par Nexus
- Impossible de modifier le registre Docker lors de l'utilisation de Boot + GKE: problème
- Impossible de remplacer le domaine nip.io par un domaine personnalisé: problème
Pour la matrice des fonctionnalités Jenkins X, le travail concerne (comme indiqué ci-dessous) les services Kubernetes d'entreprise proposés par chacun des fournisseurs de services cloud, à savoir : Google Cloud (GKE), Amazon Web Services (AWS EKS) et Azure Cloud (AKS).
- Installation de Jenkins X dans le cloud à l'aide de scripts Terraform et de
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 source, etc.) à discuter avec Deane et les membres de la communauté Jenkins X.
Concernant la configuration de l'infrastructure de l'environnement Preview de Jenkins X basé sur OpenShift, ce cours comprend les tâches suivantes:
- Document de conception sur l'infrastructure de l'environnement preview Jenkins X sur la plate-forme OpenShift
- Automatiser la création d'environnements preview Jenkins X dans OpenShift
- Mettre à jour la documentation de Jenkins X dans les environnements d'aperçu
Produits livrables du projet:
- Correction des problèmes de documentation mentionnés ci-dessus via une demande d'extraction, en vue de refactoriser la documentation Jenkins X existante.
- 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 cloud (services Kubernetes, principalement AKS, EKS et GKE).
- Configuration automatisée de l'infrastructure de l'environnement preview de Jenkins X basée sur OpenShift, en collaboration avec Daniel.
Calendrier provisoire (ainsi que les tâches) proposé:
Renforcement des liens communautaires (17 août – 13 septembre)
- Configurez l'environnement de développement pour la documentation technique et accédez aux infrastructures Cloud pour travailler sur les tâches du projet.
- Discussion avec les mentors du projet sur le calendrier provisoire proposé, les livrables du projet ainsi que les tâches (et leur priorité).
- Familiarisez-vous avec le processus de travail et le processus d'examen des communiqués de presse de l'organisation, et impliquez-vous dans la communauté.
- Consultez l'état actuel de la documentation Jenkins X.
Semaine 1 (14-20 septembre)
- Découvrez les instructions de configuration de Jenkins X dans le cloud, l'état actuel et la documentation.
- Discussion avec Deane sur les fonctionnalités actuelles de Jenkins X (à vérifier sur différents fournisseurs de services cloud).
- Discussion avec Daniel sur l'état actuel de l'infrastructure de l'environnement preview de Jenkins X basée sur OpenShift.
- Travailler (en collaboration avec Daniel) à la conception de l'architecture pour l'infrastructure de l'environnement Preview de Jenkins X sur OpenShift.
Semaine 2 (21-27 septembre)
- Travailler sur la matrice des fonctionnalités de Jenkins X pour le cloud GKE: installation de Jenkins X et préparation de notes préliminaires pour les utilisateurs.
- Travaillez sur l'un des problèmes de documentation afin d'améliorer la documentation existante sur Jenkins X.
Semaine 3 (28 septembre – 4 octobre)
- Travailler sur la matrice des fonctionnalités de Jenkins X pour le cloud GKE: installation de Jenkins X et préparation de notes préliminaires pour les utilisateurs.
- Travailler sur l'un des problèmes de documentation pour améliorer la documentation Jenkins X existante.
- Travailler sur le document de conception de l'infrastructure de l'environnement de preview Jenkins X basé sur OpenShift.
Semaine 4 (5 oct. - 11 oct.)
- Finalisation de la documentation utilisateur pour Jenkins X sur GKE.
- Travaillez sur l'un des problèmes de documentation afin d'améliorer la documentation existante sur Jenkins X.
Semaine 5 (12 oct. - 18 oct.)
- Travailler sur la matrice des fonctionnalités de Jenkins X pour le cloud Azure (AKS): installation de Jenkins X et préparation de notes préliminaires pour les utilisateurs.
- Travaillez sur l'un des problèmes de documentation afin d'améliorer la documentation existante sur Jenkins X.
- Finaliser le document de conception de l'infrastructure de l'environnement preview de Jenkins X basée sur OpenShift, après avoir reçu les commentaires des membres de la communauté.
Semaine 6 (19 oct. - 25 oct.)
- Travailler sur la matrice des fonctionnalités de Jenkins X pour le cloud Azure (AKS): installation de Jenkins X et préparation de notes préliminaires pour les utilisateurs.
- Travailler sur l'un des problèmes de documentation pour améliorer la documentation Jenkins X existante.
Semaine 7 (26 oct. – 1er nov.)
- Travailler sur la matrice des fonctionnalités de Jenkins X pour le cloud Azure (AKS): installation de Jenkins X et préparation de notes préliminaires pour les utilisateurs.
- Travaillez sur l'un des problèmes de documentation afin d'améliorer la documentation existante sur Jenkins X.
- Travailler sur la configuration de l'infrastructure de l'environnement preview de Jenkins X basée sur OpenShift.
Semaine 8 (2 nov. – 8 nov.)
- Finalisation des documentations utilisateur pour Jenkins X sur AKS.
- Travailler sur l'un des problèmes de documentation pour améliorer la documentation Jenkins X existante.
Semaine 9 (9-15 nov.)
- Travailler sur la matrice des fonctionnalités de Jenkins X pour AWS (EKS): installation de Jenkins X et préparation de notes préliminaires pour les utilisateurs.
- Travaillez sur l'un des problèmes de documentation afin d'améliorer la documentation existante sur Jenkins X.
- Travailler sur la configuration de l'infrastructure de l'environnement preview de Jenkins X basée 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 le brouillon de notes pour les utilisateurs
- Travailler sur l'un des problèmes de documentation pour améliorer la documentation Jenkins X existante.
Semaine 11 (23-29 nov.)
- Finalisation des documentations utilisateur pour Jenkins X sur EKS.
- Travailler sur l'un des problèmes de documentation pour améliorer la documentation Jenkins X existante.
- Finaliser la documentation de l'infrastructure de l'environnement preview de Jenkins X sur le site de documentation Jenkins X
Semaine 12 (30 nov. – 5 déc.)
- Finalisez les livrables du projet et refactorisez le code, le cas échéant, en fonction des commentaires.
- Testez le fonctionnement du site de documentation Jenkins X, y compris les liens, les images, les hyperliens, etc.
- Vérifiez le contrôle et la navigation définis par l'utilisateur sur le site de documentation Jenkins X.
- Consultez la présentation finalisée de la matrice des fonctionnalités de Jenkins X.
Avant le 10 décembre 2020, le rédacteur technique et les mentors envoient leur évaluation du projet.
Quels sont les avantages du projet proposé pour Jenkins X et sa communauté ? Ce projet aidera la communauté Jenkins X à améliorer la documentation destinée à ses utilisateurs finaux et aux développeurs, en fournissant des informations de référence sur l'architecture technique, la compatibilité, l'utilisation et l'intégration de Jenkins X. Une fois ce projet proposé terminé, une documentation utilisateur complète, bien définie et techniquement validée de Jenkins X sera disponible, ainsi que la matrice des fonctionnalités de Jenkins X pour sa compatibilité avec différents fournisseurs de services cloud.
À l'avenir, quels avantages prévoyez-vous de travailler avec Jenkins X ? À la fin du programme Google Season of Docs 2020, je prévois de devenir un contributeur à long terme du projet Jenkins X en tant que membre actif de la communauté. Je serai toujours là pour aider les autres (nouveaux) 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 pour lesquelles je suis le mieux placé pour travailler sur ce projet:
- Je suis très méthodique et organisé. Je m'attends à tenir informés les mentors du projet et la communauté de l'organisation de l'avancement du projet via des articles de blog une fois par semaine, des réunions hebdomadaires de la SIG-docs planifiées et des e-mails réguliers.
- recherchera fréquemment les conseils ainsi que les commentaires des mentors et des membres de la communauté, afin d’avancer dans les tâches et de s’assurer que tout le monde soit sur la même longueur d’onde (mention inclusive des défis et/ou des blocages rencontrés).
- Committer régulièrement tout le code source écrit afin de le faire examiner par le mentor et les contributeurs, et documenter le travail effectué à titre de référence pour les membres de la communauté.
- Je dispose de toutes les compétences techniques requises pour travailler sur cette idée de projet. J'ai discuté de la proposition de projet avec les mentors Deane, Kara et Daniel. Je comprends parfaitement la proposition de projet et ses livrables.
- Je possède les 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. Je suis doté d'une attitude positive et je peux mener à bien le projet dans les délais avec peu de supervision.