Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Cloud Native Computing Foundation (CNCF)
- Redator técnico:
- Syam Sundar K
- Nome do projeto:
- Mais e melhores exemplos de kubectl
- Duração do projeto:
- Duração padrão (3 meses)
Project description
O objetivo deste projeto é aprimorar a folha de referência e os documentos de referência do kubectl.
Estes são os principais objetivos deste projeto: • Criar mais e melhores exemplos de kubectl • Adicionar exemplos à folha de referência do kubectl. • Refatorar documentos do kubectl para ter o máximo de utilidade.
Meta I: exemplos para o kubectl
Trabalhará em estreita colaboração com os grupos de interesse especiais da CLI para obter o contexto e os exemplos que os usuários do Kubernetes mais querem e documentar. Isso pode variar desde melhorar os comandos kubectl existentes na folha de referência até adicionar novos comandos à folha de referência.
Meta II - Mais utilidade de documentos:
Para aumentar a utilidade dos documentos, faça o seguinte:
• Elimine a dificuldade de iniciantes • Reorganize o comando kubectl em uma determinada ordem para garantir a continuidade no fluxo lógico
Elimine as dificuldades dos iniciantes com explicações melhores de comando / caso de usuário. Isso pode parecer simples, mas pode influenciar significativamente os iniciantes a continuar ou abandonar o aprendizado. Por exemplo, quando comecei a usar o Kubernetes com o kubectl, não tinha certeza das diferenças entre pods e implantações. Inicialmente, implantei um serviço de back-end escrito em nodejs. Depois de algumas horas, queria desativar o recurso, então tentei excluir o pod, mas, devido à natureza de autorrecuperação dos pods, eles foram criados novamente. Fiquei meio confuso com o que estava acontecendo e me perguntei por que ele estava sendo recriado e não excluído. Depois de algumas pesquisas na Web, descobri que excluir pods não é o mesmo que excluir uma implantação. Para um olhar treinado, isso pode parecer simples, mas uma explicação clara que elimina esses tipos de ambiguidades é o que distingue um bom documento de um ótimo documento.
Reorganizar o comando kubectl em uma determinada ordem para garantir a continuidade no fluxo lógico. Se você é alguém como eu, que acredita muito na narrativa, provavelmente está se perguntando: como é possível colocar elementos narrativos em uma planilha com uma lista de comandos do terminal? Tudo o que aprendemos tem um fluxo lógico: um ponto inicial e um final, por assim dizer. O kubectl como uma ferramenta de linha de comando obviamente tem uma curva de aprendizado. Na verdade, ela coincide com a do Kubernetes. Como quase todo mundo inicia a jornada com o Kubernetes pelo kubectl (exceto as pessoas que usam a interface da Web) e a curva de aprendizado está fortemente associada à curva de aprendizado do Kubernetes, basta alterar a ordem desses comandos e adicionar elementos narrativos a eles. Por exemplo, imagine que atributos como o escalonamento automático horizontal de pods podem ser explicados depois de explicar os recursos com exemplos e ilustrações reais.
Meta III - Melhorias na usabilidade dos Documentos:
A migração recente do site Kubernetes para o Docsy Hugo é incrível e representa uma grande mudança na perspectiva dos documentos. Embora a migração tenha sido bem-sucedida, ainda há espaço para muitas melhorias no espaço dos documentos.
Aqui estão algumas mudanças que eu sugiro,
• Rolagem automática do painel esquerdo até a seção ativa nos documentos principais - Isso pode ser útil para acompanhar as seções atual, futuras e anteriores. • Copiar para a área de transferência: alguns comandos podem ser longos, e a funcionalidade de cópia pode ser útil ao trabalhar com esses tipos de comandos. • Formatação de conteúdo de arquivos de documentos: após a migração, o conteúdo de algumas páginas não é formatado de forma adequada. Por exemplo, seção "Tipo de recurso" na visão geral do kubectl. Isso prejudica a experiência do usuário.
Essas mudanças podem melhorar a experiência do usuário no site do Kubernetes e aumentar a produtividade.