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 Google Season of Docs.

Resumo do projeto

Organização de código aberto:: Jenkins X
Redator técnico:: Nitin
Nome do projeto:: Refactoring the existing Jenkins X docs site and Jenkins X Capabilities Matrix
Duração do projeto:: Duração padrão (três meses)

Project description

O objetivo principal deste projeto é refazer a documentação atual do Jenkins X, corrigir os problemas relacionados aos documentos e preparar a matriz de recursos atualizada do Jenkins X, além da documentação do usuário sobre o uso do Jenkins X nos provedores de nuvem corporativos. Além disso, o projeto também envolve o desenvolvimento da infraestrutura do ambiente de pré-lançamento do Jenkins X com base no OpenShift, em colaboração com Daniel.

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

Inicialização em recursos do EKS: problema
O Vault falha no EKS com inicialização: problema
Documentar envars para inicialização jx: problema
Documentação necessária para a configuração do Vault: problema
O upgrade de inicialização do local para o cofre falhou: problema
Relação de feedback da documentação de "create" x "install jx" x "boot" x "import": problema
A documentação do Helm está espalhada: problema
Melhorar a documentação sobre por que o ChartMuseum, o Monocular e o Docker Registry não são substituídos pelo Nexus
Não foi possível alterar o registro do Docker ao usar inicialização + GKE: problema
A mudança do domínio de nip.io para um domínio personalizado falha: problema

Para a matriz de recursos do Jenkins X, o trabalho envolve (conforme mencionado abaixo) os serviços empresariais do Kubernetes oferecidos por cada um dos provedores de nuvem, 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
Verificação da compatibilidade das versões do Kubernetes com o Jenkins X nos serviços do Kubernetes desses provedores de nuvem.
Qualquer outra capacidade (armazenamento do Vault para secrets, versões de controle de origem ou outras) a ser discutida com Deane e os membros da comunidade do Jenkins X.

Em relação ao trabalho de configuração da infraestrutura do ambiente de pré-lançamento do Jenkins X com base no OpenShift, o trabalho inclui:

Documento de design sobre a 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
Atualização da documentação do Jenkins X em ambientes de pré-lançamento

Resultados do projeto:

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

Cronograma provisório (com as tarefas) proposto:

Ligação comunitária (17 de agosto a 13 de setembro)

Configurar o ambiente de desenvolvimento para documentação técnica, bem como ter acesso às infraestruturas do Cloud para trabalhar nas tarefas do projeto.
Discussão com os mentores do projeto sobre o cronograma proposto, os resultados do projeto e as tarefas (com a prioridade delas).
Entenda e se familiarize com o processo de trabalho da organização, o processo de revisão de RP e participe da comunidade.
Revise o estado atual da documentação do Jenkins X.

Semana 1 (14 a 20 de setembro)

Entenda 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 serem verificados 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.
Trabalhar (em colaboração com Daniel) para projetar a arquitetura da infraestrutura do ambiente de visualização do Jenkins X no OpenShift.

Semana 2 (21 a 27 de setembro)

Trabalhar na matriz de capacidade do Jenkins X para a nuvem do GKE: instalação do Jenkins X e preparação de notas de usuário.
Trabalhar em um dos problemas de documentos para melhorar a documentação existente do Jenkins X.

Semana 3 (28 de setembro a 4 de outubro)

Trabalhar na matriz de recursos do Jenkins X para a nuvem do GKE: 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 existente do Jenkins X.
Trabalhe no documento de design para a infraestrutura do ambiente de visualização do Jenkins X com base no OpenShift.

Semana 4 (5 a 11 de outubro)

Finalizar a documentação do usuário para o Jenkins X no GKE.
Trabalhar em um dos problemas de documentos para melhorar a documentação existente do Jenkins X.

Semana 5 (12 a 18 de outubro)

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

Semana 6 (19 a 25 de outubro)

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

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

Trabalhar na matriz de capacidade do Jenkins X para a nuvem do Azure (AKS): instalação do Jenkins X e preparação de notas de usuário.
Trabalhar em um dos problemas de documentos para melhorar a documentação existente 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)

Finalizar a documentação do usuário para o Jenkins X no AKS.
Trabalhar em um dos problemas de documentos para melhorar a documentação existente do Jenkins X.

Semana 9 (9 a 15 de novembro)

Trabalhe na matriz de capacidade do Jenkins X para AWS (EKS): instalação do Jenkins X e preparação de notas do usuário.
Trabalhe em um dos problemas de documentos para melhorar a documentação existente 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 do usuário.
Trabalhar em um dos problemas de documentos para melhorar a documentação existente do Jenkins X.

Semana 11 (23 a 29 de novembro)

Finalizar a documentação do usuário para o Jenkins X no EKS.
Trabalhe em um dos problemas de documentos para melhorar a documentação existente do Jenkins X.
Finalizar a documentação da infraestrutura do ambiente de pré-lançamento do Jenkins X no site de documentos do Jenkins X.

Semana 12 (30 de novembro a 5 de dezembro)

Finalize as entregas do projeto e refatore o código, se houver, com base no feedback.
Teste 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 no site de documentos do Jenkins X.
Confira a apresentação final da matriz de recursos do Jenkins X.

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

Quais benefícios o projeto proposto tem para o Jenkins X e a comunidade dele? Esse projeto vai ajudar a comunidade do Jenkins X a melhorar a documentação para os usuários finais e os desenvolvedores como referência sobre a arquitetura técnica, a compatibilidade, o uso e a integração do Jenkins X. Com a conclusão deste projeto proposto, haveria uma documentação de usuário completa, bem definida e verificada tecnicamente do Jenkins X, além da matriz de recursos do Jenkins X para compatibilidade com diferentes provedores de nuvem.

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

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

Sou muito metódico e organizado. Espero manter os mentores do projeto e a comunidade da organização informados sobre o progresso do projeto uma vez por semana, por meio de postagens no blog, reuniões semanais programadas no SIG-docs e e-mails regulares.
Vai buscar orientação e feedback dos mentores e membros da comunidade com frequência para progredir nas tarefas e garantir que todos estejam na mesma página (incluindo a menção de desafios e/ou pontos de bloqueio enfrentados).
Commitir todo o código-fonte escrito regularmente para que o mentor e os colaboradores possam revisar o código e documentar o trabalho feito para referência dos membros da comunidade.
Tenho todas as habilidades técnicas necessárias para trabalhar nessa ideia e discuti a proposta 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 relacionados à documentação atual. Tenho uma atitude positiva e posso fazer o projeto no prazo com pouca supervisão.