Editar um artigo de documentação no navegador

  • 5 minutos

Agora que você tem uma visão geral das ferramentas e elementos dinâmicos nos bastidores de uma contribuição, vamos examinar as etapas específicas para se fazer uma pequena contribuição para a documentação da Microsoft. Quando você quiser fazer uma pequena alteração em um artigo, primeiro verifique se você tem as ferramentas apropriadas configuradas. Em seguida, você poderá começar a editar e compartilhar seu conhecimento com outros membros da comunidade do Microsoft Learn.

Etapa 1: Configure sua conta do GitHub

Como o Microsoft Learn integra fluxos de trabalho do GitHub para atualizar conteúdo, você vai precisar de uma conta do GitHub para contribuir. Se já tiver uma conta do GitHub, certifique-se de estar conectado.

Se ainda não tiver uma conta do GitHub, use as seguintes etapas para criar uma:

  1. Navegue até o GitHub.
  2. Selecione Inscrever-se.
  3. Siga os prompts para configurar sua conta.

Etapa 2: Faça suas alterações

Lembre-se de que nem todo o conteúdo do Microsoft Learn é armazenado em um repositório público. Antes de fazer qualquer alteração, primeiro verifique se o conteúdo para o qual você gostaria de contribuir está disponível para contribuição pública. Nesse caso, você pode fazer alterações diretamente no navegador.

  1. Navegue até o artigo de documentação em learn.microsoft.com que você quer editar. Verifique se o artigo está armazenado em um repositório público procurando o ícone Editar em forma de lápis na parte superior do artigo. Se estiver vendo o ícone, significa que se qualifica à contribuição pública.

  2. Selecione o ícone de lápis Editar. Isso leva você ao arquivo de origem no repositório público do GitHub em que o artigo está armazenado.

    Captura de tela de um artigo de documentação do Microsoft Learn com o ícone Editar lápis realçado.

  3. Selecione o ícone de lápis na parte superior da página de arquivo do GitHub. Esse ícone é rotulado como Editar esse arquivo no seu fork desse projeto ou Criar um fork desse repositório e editar o arquivo, dependendo de você já ter criado um fork do repositório em que o arquivo está armazenado.

    Nesta altura você precisa estar conectado à sua conta do GitHub para selecionar esse ícone. Se você não estiver conectado, essa opção não estará disponível.

    Captura de tela do arquivo de origem do GitHub para um artigo de documentação. O ícone Editar lápis de arquivo está realçado.

    Na parte superior do artigo, você verá os metadados do artigo. Os metadados são aplicados aos artigos para geração de relatórios, capacidade de descoberta por meio de pesquisa e aspectos de condução da experiência do site. Se você estiver fazendo pequenas atualizações em um artigo publicado, provavelmente não precisará alterar os metadados.

  4. Se esta for a primeira vez que você está trabalhando neste repositório, será solicitado que você crie um fork do repositório antes de propor alterações. Em caso afirmativo, selecione Criar fork deste repositório.

  5. Você verá a interface de edição ou o painel Editar no seu navegador. Você pode ver o artigo escrito em Markdown, uma sintaxe de formatação. Faça suas alterações no painel.

    Captura de tela de um navegador com um artigo de documentação escrito na sintaxe Markdown, que pode ser editado no painel Editar.

  6. Na parte superior do painel de edição, selecione a guia Visualização. Isso permite que você valide suas alterações exibindo-as no formulário publicado.

Etapa 3: Criar seu pull request

Quando terminar de fazer e visualizar suas alterações, chegou a hora de criar seu pull request (PR). Lembre-se de que um PR é sua maneira de propor que suas alterações sejam mescladas à ramificação principal do repositório ativo para se tornarem visíveis no Microsoft Learn. Um PR permite que o modelo de colaboração do GitHub solicite que as alterações da ramificação de trabalho sejam extraídas e mescladas em outra ramificação. Na maioria dos casos, esse outra ramificação é a padrão no repositório principal.

  1. Localize e selecione o botão Fazer commit de alterações ou Propor alterações, geralmente na parte superior da página.

  2. Adicione uma Mensagem de commit. Isso se tornará o título de seu PR. A mensagem de commit deve ser um breve resumo de suas alterações. Opcionalmente, adicione uma descrição estendida para fornecer mais detalhes sobre suas alterações.

    Captura de tela da caixa pop-up com dois campos para criar uma mensagem de Commit e adicionar uma descrição detalhada das alterações.

  3. Selecione Propor alterações.

  4. A próxima página solicita que você verifique para onde quer mesclar suas alterações, chamada de base. Confirme se a base é main.

    Captura de tela da página da Web na qual os colaboradores devem verificar o repositório de destino e o branch no qual desejam mesclar alterações. Principal é selecionado como Base.

  5. Selecione Criar solicitação de pull.

  6. Visualize seu PR. Faça alterações nos campos de título ou descrição.

  7. Selecione o botão Criar pull request. Isso abrirá seu pull request.

Seu PR foi criado, mas ainda não foi enviado. Na próxima etapa, você vai executar as etapas finais de verificação no seu PR para mesclá-lo.

Cenário: Editar um artigo do Serviço de Aplicativo do Azure

Lembre-se de que você é um engenheiro de software com experiência especial no Serviço de Aplicativo do Azure. Ao revisar um artigo de documentação sobre o Serviço de Aplicativo, você percebeu um detalhe que gostaria de adicionar e que ajudaria outras pessoas a usar o serviço. Você decide compartilhar seu conhecimento fazendo sua primeira contribuição para o Microsoft Learn! Depois de entrar em sua conta do GitHub, você começa o processo de contribuição: