Visão geral da edição da documentação no Microsoft Learn
Obrigado pelo seu interesse em editar a documentação no Microsoft Learn! Suas contribuições nos ajudam a garantir que nossa documentação seja bem escrita, atualizada e precisa. As informações nesta página irão ajudá-lo a decidir qual método de contribuição é melhor para você.
Pré-requisito
Antes de começar, verifique se você está conectado à sua conta do GitHub. Se você não tiver uma conta do GitHub, navegue até https://github.com/join para obter um processo de inscrição rápido e gratuito.
Pequenas alterações na documentação
É fácil e rápido fazer pequenas alterações. Exemplos de alterações pequenas incluem:
- Correção de erro de digitação
- Revisão de um único artigo
- Adição de uma seção a um artigo
- Correção de um erro
- Atualização de links quebrados
Para fazer pequenas alterações, basta uma conta no GitHub!
Para fazer uma pequena alteração, selecione o ícone de lápis Editar este documento na parte superior do artigo. Essa ação leva você ao arquivo de origem no GitHub, onde você pode fazer as alterações. Quando terminar, você será solicitado a criar uma solicitação pull (PR) para propor suas alterações. Para obter um passo a passo completo desse processo, consulte Editar documentação no navegador.
Alterações grandes na documentação
Grandes mudanças envolvem mais tempo e esforço. Exemplos de alterações grandes incluem:
- Alterações complexas que levarão vários dias para serem concluídas
- Revisões de vários artigos que você deseja enviar juntos
- Criando um artigo
- Contribuindo com frequência
Se você estiver fazendo grandes alterações, precisará baixar e instalar algumas ferramentas para facilitar seu trabalho. Siga estas etapas para começar:
- Instalar ferramentas do Git e do Markdown
- Configurar um repositório Git local
- Faça alterações na documentação.
- Crie um PR.
Visão geral do processo
O fluxo de processo abaixo mostra as etapas de alto nível envolvidas no início de pequenas e grandes alterações. Observe que alguns itens são etapas avulsas, enquanto outros ocorrem toda vez que você inicia uma nova contribuição.
A imagem começa com um momento de decisão: esta é a primeira vez que você contribui? Se sim, a próxima etapa é configurar sua conta do GitHub. Se não, a próxima etapa é outro momento de decisão: sua alteração é pequena? Se sim, a próxima etapa é editar no browser. Se não, as próximas etapas envolvem instalar ferramentas de criação, criar fork e clonar o repositório, fazer alterações, abrir uma pull request, revisar e assinar sua pull request.
Alterações nos módulos de treinamento
Os colaboradores não podem editar ou propor alterações nos módulos de treinamento. No momento, apenas a documentação do Microsoft Learn armazenada em repositórios públicos está aberta para contribuições públicas.