Contribua com a documentação do Kubernetes
O Kubernetes agradece as melhorias de todos os contribuidores, novos e experientes!
Este site é mantido pelo Kubernetes SIG Docs.
Contribuidores da documentação do Kubernetes podem:
- Melhorar o conteúdo existente
- Criar novo conteúdo
- Traduzir a documentação
- Gerenciar e publicar a documentação como parte do ciclo de lançamento do Kubernetes
Começando
Qualquer pessoa pode abrir uma issue sobre a documentação, ou contribuir com uma mudança por meio de um pull request (PR) para o repositório do Github kubernetes/website
.
É recomendável que você se sinta confortável com git e
Github para trabalhar efetivamente na comunidade Kubernetes.
Para se envolver com a documentação:
- Assine o Contrato de Licença de Colaborador do CNCF.
- Familiarize-se com o repositório de documentação e o gerador de site estático hugo.
- Certifique-se de entender os processos básicos para melhorar o conteúdo e revisar alterações.
Algumas tarefas requerem mais confiança e mais acessos na organização do Kubernetes. Veja Participando no SIG Docs para mais detalhes sobre funções e permissões.
Sua primeira contribuição
- Leia sobre visão geral para contribuição para saber mais sobre diferentes formas para você contribuir.
- Veja a lista de issues em
kubernetes/website
para identificar issues que sejam um bom ponto de partida. - Abra um pull request usando o Github para documentações existentes e aprenda mais sobre resolver issues no Github.
- Leia sobre o guia de conteúdo e guias de estilo.
- Leia sobre tipos de conteúdo de páginas e shortcodes do Hugo.
Próximos passos
- Aprenda a trabalhar com um clone local de um repositório.
- Documente funcionalidades em uma release.
- Participe do SIG Docs, e se torne um membro ou revisor.
- Comece ou ajude com uma localização.
Se envolva com o SIG Docs
O SIG Docs é um grupo de contribuidores que publica e mantém a documentação e o site do Kubernetes. Se envolver com o SIG Docs é uma ótima forma de contribuidores Kubernetes (pessoas desenvolvedoras de features ou outros) terem um grande impacto dentro do projeto Kubernetes.
A comunicação do SIG Docs é feita de diferentes formas:
- Entre em
#sig-docs
no slack do Kubernetes. - Se inscreva na lista de email
kubernetes-dig-docs
, onde acontecem discussões e decisões oficiais são registradas. - Participe do encontro semanal do SIG Docs. Os encontros são sempre anunciados no
#sig-docs
e adicionados ao calendário de eventos de comunidade do Kubernetes. Você precisa baixar o cliente do Zoom ou usar um telefone.
Outras formas de contribuir
- Para contribuir com a comunidade Kubernetes por meio de fóruns on-line, como Twitter ou Stack Overflow, ou aprender sobre encontros locais e eventos do Kubernetes, visite a area de comunidade Kubernetes.
- Para contribuir com o desenvolvimento de novas funcionalidades, leia o cheatsheet do colaborador para começar.
- Leia o cheatsheet de contribuidor para saber mais sobre as funcionalidades de desenvolvimento do Kubernetes.
- Submeta um post de blog ou um caso de estudo.