Esta página foi traduzida pela API Cloud Translation.

Projeto do Jenkins X

Esta página contém os detalhes de um projeto de redação técnica aceito para a temporada de documentos do Google.

Resumo do projeto

Organização de código aberto:: Jenkins X
Redator técnico:: Nitina
Nome do projeto:: Refatoração do site de documentos do Jenkins X e da matriz de recursos do Jenkins X
Duração do projeto:: Duração padrão (3 meses)

Project description

O principal objetivo deste projeto é refatorar a documentação atual do Jenkins X enquanto corrige os problemas relacionados aos documentos. Também é necessário preparar a matriz de recursos atualizada do Jenkins X junto com a documentação do usuário sobre o uso do Jenkins X nos provedores de nuvem empresarial. Além disso, o projeto também envolve o desenvolvimento da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift, em colaboração com Daniel.

Como parte da refatoração da documentação atual do Jenkins X, alguns dos problemas em que eu trabalharia incluem:

Recursos de inicialização no EKS: problema
O Vault falha no EKS com a inicialização: problema
Envars de documento para inicialização jx: problema
Documentação necessária para a configuração do Vault: problema
Falha no upgrade da inicialização do local para o Vault: problema
Relação do feedback sobre a documentação entre “criar” e “instalar jx” em comparação com “inicialização” e “importação”: problema
A documentação do Helm está por toda parte: problema
Melhoria na documentação por que o ChartMuseum, o Monocular e o Docker Registry não foram substituídos pelo problema com o Nexus
Não é possível alterar o registro do Docker ao usar inicialização + GKE: problema
Falha ao alterar o domínio de nip.io para um domínio personalizado: problema

Na matriz de recursos do Jenkins X, o trabalho envolve, como mencionado abaixo, serviços empresariais do Kubernetes oferecidos por cada um dos provedores do Cloud, ou seja, Google Cloud (GKE), Amazon Web Services (AWS EKS) e Azure Cloud (AKS).

Instalação do Jenkins X na nuvem por scripts do Terraform e jx boot
Verificando a compatibilidade das versões do Kubernetes com o Jenkins X nos serviços do Kubernetes dos provedores de nuvem.
Qualquer outro recurso (armazenamento no Vault para secrets, versões de controle de origem ou outros) a ser discutido com Deane e os membros da comunidade Jenkins X.

Em relação ao trabalho de configuração da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift, o trabalho inclui:

Documento de design na infraestrutura do ambiente de visualização do Jenkins X na plataforma OpenShift
Automatizar a criação de ambientes de visualização do Jenkins X no OpenShift
Atualizar a documentação do Jenkins X em ambientes de visualização

Entregas do projeto:

Correções via PR para os problemas de documentos mencionados acima, considerando a refatoração da documentação atual do Jenkins X.
Atualização da matriz de recursos do Jenkins X com a documentação do usuário sobre como usar o Jenkins X com diferentes provedores de nuvem (serviços do Kubernetes, principalmente AKS, EKS e GKE).
Configuração automatizada da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift, em colaboração com Daniel.

Cronograma provisório (junto com tarefas) proposto:

Vínculo comunitário (17 de agosto a 13 de setembro)

Configurar o ambiente de desenvolvimento para documentação técnica e acessar infraestruturas de nuvem para trabalhar nas tarefas do projeto.
Discussão com os mentores do projeto sobre o cronograma provisório proposto, as entregas do projeto e as tarefas (junto da prioridade).
Entenda e prepare-se bem com o processo de trabalho da organização e o processo de revisão de RP e envolva-se com a comunidade.
Revisar o estado atual da documentação do Jenkins X.

Semana 1 (14 de setembro a 20 de setembro)

Entender as instruções para a configuração do Jenkins X na nuvem, o estado atual e a documentação.
Discussão com Deane sobre os recursos atuais do Jenkins X (a ser verificado em diferentes provedores de nuvem).
Discussão com Daniel sobre o estado atual da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift.
Trabalhe (em colaboração com Daniel) no desenvolvimento da arquitetura para a infraestrutura do ambiente de visualização do Jenkins X no OpenShift.

Semana 2 (21 de setembro a 27 de setembro)

Trabalhar na matriz de capacidade do Jenkins X para a nuvem do GKE: instalar o Jenkins X e preparar o rascunho de notas do usuário.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.

Semana 3 (28 de setembro a 4 de outubro)

Trabalhar na matriz de capacidade do Jenkins X para a nuvem do GKE: instalar o Jenkins X e preparar o rascunho de notas do usuário.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.
Trabalhar no documento de design da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift.

Semana 4 (5 a 11 de outubro)

Finalize os documentos do usuário para o Jenkins X no GKE.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.

Semana 5 (12 a 18 de outubro)

Trabalhar na matriz de recursos do Jenkins X para Azure Cloud (AKS): instalação do Jenkins X e preparação de rascunhos de notas do usuário.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.
Finalizar o documento de design para a infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift, depois de receber o feedback dos membros da comunidade.

Semana 6 (19 a 25 de outubro)

Trabalhar na matriz de recursos do Jenkins X para Azure Cloud (AKS): instalação do Jenkins X e preparação de rascunhos de notas do usuário.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.

Semana 7 (26 de outubro a 1o de novembro)

Trabalhar na matriz de recursos do Jenkins X para Azure Cloud (AKS): instalação do Jenkins X e preparação de rascunhos de notas do usuário.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.
Trabalhar na configuração da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift.

Semana 8 (2 a 8 de novembro)

Finalize os documentos do usuário para o Jenkins X no AKS.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.

Semana 9 (9 a 15 de novembro)

Trabalhar na matriz de recursos do Jenkins X para AWS (EKS): instalação do Jenkins X e preparação de rascunhos de notas de usuários.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.
Trabalhar na configuração da infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift.

Semana 10 (16 a 22 de novembro)

Trabalhar na matriz de recursos do Jenkins X para AWS (EKS): instalação do Jenkins X e preparação de rascunhos de notas de usuários.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.

Semana 11 (23 a 29 de novembro)

Finalize os documentos do usuário para o Jenkins X no EKS.
Trabalhe em um dos problemas de documentos para melhorar a documentação atual do Jenkins X.
Finalizar a documentação da infraestrutura do ambiente de visualização do Jenkins X no site de documentos do Jenkins X.

Semana 12 (30 de novembro a 5 de dezembro)

Finalizar as entregas do projeto e refatorar o código, se houver, com base no feedback.
Testar o funcionamento do site de documentos do Jenkins X, incluindo links, imagens, hiperlinks e outros.
Verifique o controle e a navegação definidos pelo usuário do site de documentos do Jenkins X.
Verificar a apresentação finalizada da matriz de recursos do Jenkins X.

Antes de 10 de dezembro de 2020 O redator técnico e os mentores enviam uma avaliação do projeto.

Quais benefícios o projeto proposto tem para o Jenkins X e a comunidade dele? Esse projeto ajudará a comunidade do Jenkins X a melhorar a documentação para os usuários finais e os desenvolvedores para consulta sobre a arquitetura técnica, a compatibilidade, o uso e a integração do Jenkins X. Com a conclusão desse projeto proposto, existiria uma documentação do usuário completa, bem definida e tecnicamente verificada do Jenkins X, junto com a Jenkins X Capability Matrix para a compatibilidade com diferentes provedores de nuvem.

Quais benefícios futuros você planeja trabalhar com o Jenkins X? Após o final do programa Google Season of Docs 2020, pretendo me tornar um colaborador de longo prazo para o projeto Jenkins X como um membro ativo da comunidade. Estarei sempre por perto para ajudar os outros (novos) e incentivá-los a se envolverem na comunidade Jenkins X. Sempre estaria disposto a trabalhar em outras ideias do projeto do Jenkins X.

Alguns dos motivos que me tornam mais adequado para trabalhar neste projeto:

Sou muito metódico e organizado. Eu espero ser informado sobre o andamento do projeto, tanto para os mentores do projeto quanto para a comunidade organizacional, com postagens em blogs uma vez por semana, reuniões semanais agendadas do SIG-docs e por meio de e-mails regularmente.
Procurará orientação, bem como feedback dos mentores e membros da comunidade com frequência, para progredir nas tarefas e garantir que todos estejam alinhados (menção inclusiva de quaisquer desafios e/ou pontos de bloqueio enfrentados).
Comprometer todo o código-fonte escrito regularmente, de modo que o código seja revisado pelo mentor, pelos colaboradores e documentando o trabalho feito para referência aos membros da comunidade.
Tenho todas as habilidades técnicas necessárias para trabalhar na ideia do projeto e conversei sobre a proposta do projeto com os mentores Deane, Kara e Daniel. Tenho uma compreensão profunda da proposta do projeto e das entregas.
Tenho experiência em trabalhar com as habilidades técnicas (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo e outras) necessárias para fornecer uma documentação completa e resolver a maioria dos problemas atuais relacionados à documentação. Tenho uma atitude positiva que pode fazer o trabalho do projeto no prazo e com pouca supervisão.