Editar um artigo de documentação no seu navegador

  • 5 minutos

Agora que você tem uma visão geral das ferramentas gerais e partes móveis nos bastidores de uma contribuição, vamos examinar as etapas específicas para fazer uma pequena contribuição para a documentação da Microsoft. Quando você quiser fazer uma pequena alteração em um artigo, primeiro certifique-se de ter as ferramentas apropriadas configuradas. Em seguida, você estará pronto para começar a editar e compartilhar seu conhecimento com outros membros da comunidade do Microsoft Learn.

Etapa 1: configurar sua conta do GitHub

Como o Microsoft Learn integra fluxos de trabalho do GitHub para atualizar conteúdo, você precisa de uma conta do GitHub para contribuir. Se você já tiver uma conta do GitHub, verifique se está conectado.

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

  1. Navegue até www.github.com
  2. Selecione Inscrever-se.
  3. Siga as instruções para configurar sua conta.

Etapa 2: faça as alterações

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

  1. Navegue até o artigo de documentação sobre zcusa.951200.xyz que você deseja 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 vir o ícone, é elegível para 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 no qual o artigo está armazenado.

    Screenshot of a Microsoft Learn documentation article with the pencil Edit icon highlighted.

  3. Selecione o ícone de lápis na parte superior da página do arquivo GitHub. Este ícone é rotulado como Editar este arquivo na bifurcação deste projeto ou Fork este repositório e editar o arquivo, dependendo se você já bifurcou o repositório onde o arquivo está armazenado.

    Você precisa estar conectado à sua conta do GitHub neste momento para selecionar este ícone Editar . Se não tiver sessão iniciada, esta opção não estará disponível.

    Screenshot of the GitHub source file for a documentation article. The Edit file pencil icon is highlighted.

    Na parte superior do artigo, você notará os metadados do artigo. Os metadados são aplicados a artigos para geração de relatórios, descoberta por meio de pesquisa e aspetos determinantes 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ê trabalha neste repositório, você será solicitado a bifurcar o repositório antes de propor alterações. Em caso afirmativo, selecione Fork this repository.

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

    Screenshot of a browser with a documentation article written in Markdown syntax, which can be edited in the Edit pane.

  6. Na parte superior do painel de edição, selecione a guia Visualizar . Isto permite-lhe validar as suas alterações visualizando-as na sua forma publicada.

Passo 3: Crie o seu pull request

Quando terminar de fazer e visualizar as alterações, é hora de criar sua solicitação pull (PR). Lembre-se de que um RP é sua maneira de propor que suas alterações sejam mescladas à ramificação principal do repositório ao vivo para se tornarem visíveis no Microsoft Learn. Um RP permite o modelo de colaboração do GitHub, solicitando que as alterações do seu ramo de trabalho sejam puxadas e fundidas em outro ramo. Na maioria dos casos, essa outra ramificação é a ramificação padrão no repositório principal.

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

  2. Adicione uma mensagem de confirmação. Este passa a ser o título do seu PR. A mensagem de confirmação deve ser um breve resumo das alterações. Opcionalmente, adicione uma descrição estendida para fornecer mais detalhes sobre suas alterações.

    Screenshot of the pop up box with two fields to create a Commit message and add an extended description of the changes.

  3. Selecione Propor alterações.

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

    Screenshot of the webpage where contributors should verify the destination repository and branch they want to merge changes to. Main is selected as the Base.

  5. Selecione Criar pull request.

  6. Pré-visualize o seu PR. Faça quaisquer alterações nos campos de título ou descrição.

  7. Selecione o botão Criar pull request . Isso abrirá sua solicitação pull.

O seu PR foi criado, mas ainda não foi submetido. Na próxima etapa, você concluirá as etapas finais de verificação em seu RP para mesclá-lo.

Cenário: Editar um artigo do Serviço de Aplicativos 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ê percebe um detalhe que gostaria de adicionar 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 na sua conta do GitHub, você começa o processo de contribuição: