Se usó la API de Cloud Translation para traducir esta página.

Proyecto de Jenkins X

Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.

Resumen del proyecto

Organización de código abierto:: Jenkins X
Redactor técnico:: Nitin
Nombre del proyecto:: Refactorizar el sitio de documentos existente de Jenkins X y la matriz de funciones de Jenkins X
Duración del proyecto:: Duración estándar (3 meses)

Project description

El objetivo principal de este proyecto es refactorizar la documentación existente de Jenkins X mientras corrige los problemas relacionados con los documentos, así como preparar la matriz de capacidades actualizada de Jenkins X junto con la documentación del usuario sobre el uso de Jenkins X en los proveedores de servicios en la nube empresariales. Además, este proyecto también implica trabajar en el desarrollo de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift, en colaboración con Daniel.

Como parte de la refactorización de la documentación existente de Jenkins X, algunos de los problemas en los que trabajaría incluyen los siguientes:

Inicio en los recursos de EKS: Problema
Vault falla en EKS con inicio: Problema
Documenta los entornos para el inicio de jx: Problema
Documentación necesaria para la configuración de Vault: Problema
La actualización del inicio de la versión local a la bóveda falla: Problema
Relación de comentarios de documentación de “crear” en comparación con “instalar jx”, “inicio” o “importar”: Problema
La documentación de Helm está por todos lados: problema
Se mejoró la documentación por qué ChartMuseum, Monocular y Docker Registry no se reemplazan por un problema de Nexus.
No se puede cambiar el registro de Docker cuando se usa Boot y GKE: Problema
No se puede cambiar el dominio de nip.io a un dominio personalizado: Problema

Para la matriz de capacidades de Jenkins X, el trabajo involucra (como se menciona a continuación) los servicios empresariales de Kubernetes que ofrece cada uno de los proveedores de servicios en la nube, es decir, Google Cloud (GKE), Amazon Web Services (AWS EKS) y Azure Cloud (AKS).

Instalación de Jenkins X en la nube a través de secuencias de comandos de Terraform y jx boot
Verificar la compatibilidad de las versiones de Kubernetes con Jenkins X en los servicios de Kubernetes de estos proveedores de servicios en la nube
Cualquier otra función (almacenamiento de Vault para secretos, versiones de control de código fuente u otras) que se tratará con Deane y los miembros de la comunidad de Jenkins X.

En cuanto al trabajo de configuración de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift, el trabajo incluye lo siguiente:

Documento de diseño en la infraestructura del entorno de vista previa de Jenkins X en la plataforma OpenShift
Automatiza la creación de entornos de vista previa de Jenkins X en OpenShift
Se actualizó la documentación de Jenkins X en entornos de vista previa.

Entregables del proyecto:

Se realizaron correcciones a través de PR en los problemas de documentación mencionados anteriormente, teniendo en cuenta la refactorización de la documentación existente de Jenkins X.
Se actualizó la matriz de capacidades de Jenkins X junto con la documentación para el usuario sobre el uso de Jenkins X con diferentes proveedores de servicios en la nube (servicios de Kubernetes, principalmente AKS, EKS y GKE).
Configuración automatizada de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift, en colaboración con Daniel.

Cronograma tentativo (junto con las tareas) propuesto:

Vinculación a la comunidad (del 17 de agosto al 13 de septiembre)

Configura el entorno de desarrollo para la documentación técnica y obtén acceso a las infraestructuras de Cloud para trabajar en las tareas del proyecto.
Conversación con los mentores del proyecto sobre el cronograma tentativo propuesto, los entregables del proyecto y las tareas (junto con su prioridad).
Comprende y prepárate bien con el proceso de trabajo de la organización, el proceso de revisión de relaciones públicas y participa en la comunidad.
Revisa el estado actual de la documentación de Jenkins X.

Semana 1 (del 14 al 20 de septiembre)

Comprende las instrucciones para la configuración de Jenkins X en la nube, el estado actual y la documentación.
Conversación con Deane sobre las capacidades actuales de Jenkins X (que se verificarán en diferentes proveedores de servicios en la nube).
Conversación con Daniel sobre el estado actual de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift.
Trabajar (en colaboración con Daniel) para diseñar la arquitectura de la infraestructura del entorno de vista previa de Jenkins X en OpenShift

Semana 2 (del 21 al 27 de septiembre)

Trabaja en la matriz de capacidades de Jenkins X para la nube de GKE: instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas relacionados con los documentos para mejorar la documentación existente de Jenkins X.

Semana 3 (del 28 de septiembre al 4 de octubre)

Trabaja en la matriz de capacidades de Jenkins X para la nube de GKE: instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas de documentación para mejorar la documentación existente de Jenkins X.
Trabajar en el documento de diseño para la infraestructura del entorno de vista previa de Jenkins X basado en OpenShift

Semana 4 (del 5 al 11 de oct)

Finaliza los documentos de usuario de Jenkins X en GKE.
Trabaja en uno de los problemas relacionados con los documentos para mejorar la documentación existente de Jenkins X.

Semana 5 (del 12 al 18 de oct)

Trabaja en la matriz de capacidades de Jenkins X para la nube de Azure (AKS): instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas de documentación para mejorar la documentación existente de Jenkins X.
Finaliza el documento de diseño para la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift después de recibir comentarios de los miembros de la comunidad.

Semana 6 (del 19 al 25 de octubre)

Trabaja en la matriz de capacidades de Jenkins X para la nube de Azure (AKS): instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas de documentación para mejorar la documentación existente de Jenkins X.

Semana 7 (del 26 de octubre al 1 de noviembre)

Trabaja en la matriz de capacidades de Jenkins X para la nube de Azure (AKS): instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas de documentación para mejorar la documentación existente de Jenkins X.
Trabaja en la configuración de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift.

Semana 8 (del 2 al 8 de noviembre)

Finaliza los documentos de usuario para Jenkins X en AKS.
Trabaja en uno de los problemas de documentación para mejorar la documentación existente de Jenkins X.

Semana 9 (del 9 al 15 de noviembre)

Trabaja en la matriz de capacidades de Jenkins X para AWS (EKS): instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas relacionados con los documentos para mejorar la documentación existente de Jenkins X.
Trabaja en la configuración de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift.

Semana 10 (del 16 al 22 de noviembre)

Trabaja en la matriz de capacidades de Jenkins X para AWS (EKS): instalación de Jenkins X y preparación de notas de usuario en borrador.
Trabaja en uno de los problemas de documentación para mejorar la documentación existente de Jenkins X.

Semana 11 (del 23 al 29 de noviembre)

Finaliza la documentación para el usuario de Jenkins X en EKS.
Trabaja en uno de los problemas relacionados con los documentos para mejorar la documentación existente de Jenkins X.
Finaliza la documentación de la infraestructura del entorno de vista previa de Jenkins X en el sitio de documentación de Jenkins X.

Semana 12 (del 30 de noviembre al 5 de diciembre)

Finaliza los entregables del proyecto y refactoriza el código, si corresponde, según los comentarios.
Prueba el funcionamiento del sitio de documentación de Jenkins X, incluidos los vínculos, las imágenes, los hipervínculos y otros elementos.
Verifica el control y la navegación definidos por el usuario del sitio de documentación de Jenkins X.
Revisa la presentación finalizada de la matriz de capacidades de Jenkins X.

Antes del 10 de diciembre de 2020 El escritor técnico y los mentores envían la evaluación del proyecto.

¿Qué beneficios tiene el proyecto propuesto para Jenkins X y su comunidad? Este proyecto ayudará a la comunidad de Jenkins X a mejorar la documentación para sus usuarios finales y desarrolladores como referencia sobre la arquitectura técnica, la compatibilidad, el uso y la integración de Jenkins X. Cuando se complete este proyecto propuesto, existirá una documentación para el usuario de Jenkins X completa, bien definida y verificada técnicamente, junto con la matriz de capacidades de Jenkins X para su compatibilidad con diferentes proveedores de servicios en la nube.

¿En qué beneficios futuros planeas trabajar con Jenkins X? Después de que finalice el programa de la Temporada de Documentos de Google de 2020, planeo convertirme en un colaborador a largo plazo del proyecto Jenkins X como miembro activo de la comunidad. Siempre estaré disponible para ayudar a otros (recién llegados) y alentarlos a participar en la comunidad de Jenkins X. Siempre estaría dispuesto a trabajar en otras ideas de proyectos de Jenkins X.

Estos son algunos de los motivos por los que creo que soy la persona adecuada para trabajar en este proyecto:

Soy muy metódico y organizado. Espero mantener informados a los mentores del proyecto y a la comunidad de la organización sobre el progreso del proyecto a través de publicaciones de blog una vez a la semana, reuniones semanales programadas de SIG-docs y correos electrónicos con regularidad.
Buscará orientación y comentarios de los mentores y miembros de la comunidad con frecuencia para avanzar con las tareas y asegurarse de que todos estén en sintonía (incluida la mención de cualquier desafío o punto de bloqueo que se haya encontrado).
Confirmar todo el código fuente escrito con regularidad para que el mentor y los colaboradores lo revisen, y documentar el trabajo realizado como referencia para los miembros de la comunidad.
Tengo todas las habilidades técnicas necesarias para trabajar en este proyecto y debatí la propuesta con los mentores Deane, Kara y Daniel. Comprendí en detalle la propuesta del proyecto y sus entregables.
Tengo experiencia en el trabajo con las habilidades técnicas (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo y otras) necesarias para proporcionar una documentación completa y resolver la mayoría de los problemas relacionados con la documentación actual. Tengo una actitud positiva y puedo hacer que el proyecto se realice a tiempo con poca supervisión.