Guia de Conteúdo da Documentação
Esta página contém orientações para a documentação do Kubernetes.
Se você tiver dúvidas sobre o que é permitido, junte-se ao canal #sig-docs no Slack do Kubernetes e pergunte!
Você pode se registrar no Slack do Kubernetes através do endereço https://slack.k8s.io/.
Para informações sobre como criar novo conteúdo para a documentação do Kubernetes, siga o guia de estilo.
Visão geral
O código-fonte para o website do Kubernetes, incluindo a documentação, é armazenado no repositório kubernetes/website.
Localizada dentro da pasta kubernetes/website/content/<codigo-do-idioma>/docs,
a maior parte da documentação do Kubernetes é específica para o
projeto Kubernetes.
O que é permitido
A documentação do Kubernetes permite conteúdo de projetos de terceiros somente quando:
- O conteúdo documenta software que existe no projeto Kubernetes
- O conteúdo documenta software que está fora do projeto, mas é necessário para o funcionamento do Kubernetes
- O conteúdo é canônico no kubernetes.io, ou está vinculado a conteúdo canônico em outro local
Conteúdo de terceiros
A documentação do Kubernetes contém exemplos aplicados de projetos no projeto Kubernetes — projetos que existem nas organizações kubernetes e kubernetes-sigs do GitHub.
Links para conteúdo ativo no projeto Kubernetes sempre são permitidos.
O Kubernetes requer alguns conteúdos de terceiros para funcionar. Exemplos incluem agentes de execução de contêiner (containerd, CRI-O, Docker), políticas de rede (plugins CNI), controladores Ingress, e sistemas de log.
A documentação pode conter vínculos com software de código aberto de terceiros fora do projeto Kubernetes somente quando estes projetos são necessários para o funcionamento do Kubernetes.
Conteúdo duplicado
Sempre que possível, a documentação do Kubernetes utiliza links para fontes canônicas de documentação ao invés de hospedar conteúdo duplicado.
Conteúdo duplicado requer o dobro de esforço (ou mais!) para manter e fica obsoleto mais rapidamente.
Nota:
Se você é um mantenedor e precisa de auxílio para hospedar sua própria documentação, solicite ajuda no canal #sig-docs do Slack do Kubernetes.Mais informações
Se você tem dúvidas sobre o conteúdo permitido, junte-se ao canal #sig-docs do Slack do Kubernetes e faça sua pergunta!
Próximos passos
- Leia o guia de estilo.