Examinar a documentação usando problemas do GitHub
Uma das maneiras mais úteis de contribuir com o Microsoft Learn é fazer comentários diretamente em um artigo de documentação. Usando o link de comentários na página, você pode fornecer edições, sugestões, perguntas ou outras informações conforme elas aparecem em sua navegação. Como a maioria do conteúdo da documentação do Microsoft Learn é armazenada em repositórios do GitHub, você pode fornecer seus comentários usando um processo do GitHub chamado envio de um Problema do GitHub.
Um Problema no GitHub é uma ferramenta que permite que usuários de tecnologia, engenheiros e outros visitantes do Microsoft Learn compartilhem e acompanhem comentários em um artigo específico. Você preenche um formulário para documentar seus comentários e postá-los no repositório do artigo de origem no GitHub, onde um autor ou proprietário será notificado. Qualquer pessoa que visita o repositório GitHub pode ver Problemas. Eles servem como uma maneira útil de coletar e armazenar comentários valiosos, como relatar bugs, solicitações de recursos ou anotações.
Por que revisar o conteúdo no GitHub?
Fornecer revisões de conteúdo no GitHub é uma maneira direta de contribuir para um tópico pelo qual você é apaixonado ou conhecedor. Isso significa que você pode adicionar suas ideias enquanto está explorando um tópico na documentação da Microsoft. Contribuir com suas ideias para o pool de conhecimento ajuda a melhorar as experiências de produtos da Microsoft para milhões de outros usuários. Seus comentários avançam no conteúdo para outros visitantes do Microsoft Learn que dependem de produtos da Microsoft e de seu conteúdo de suporte.
Na maioria dos casos, enviar comentários do GitHub permite que você envie suas ideias para a equipe responsável pelo conjunto de conteúdo do produto. Esse caminho de colaboração entre equipes de conteúdo e usuários de produtos permite que os comentários sejam compartilhados e discutidos diretamente no GitHub.
Contribuir com o conteúdo da documentação também pode fornecer benefícios profissionais para você. O GitHub é uma plataforma conhecida em que as contribuições técnicas podem ser feitas e controladas. Cada vez que você contribui para um projeto no GitHub, ele é refletido em seu perfil do GitHub. Ao longo do tempo, você pode criar um registro de suas contribuições para adicionar ao seu portfólio técnico.
Como fazer comentários sobre o conteúdo
Lembre-se de que muitos artigos de documentação sobre o Microsoft Learn são armazenados em repositórios do GitHub. Muitos repositórios do GitHub têm problemas do GitHub habilitados. Quando habilitado, você pode encontrar a opção de enviar comentários para esta página na parte inferior de um artigo sobre learn.microsoft.com.
Para criar e enviar um problema, você precisa de uma conta do GitHub. Veja como enviar um problema no GitHub de um artigo do Microsoft Learn:
Entre com sua conta do GitHub.
Navegue até o artigo de documentação do Microsoft Learn no qual você gostaria de fazer comentários.
Na parte inferior do artigo, localize o título rotulado Comentários. Aqui, você verá uma caixa rotulada Esta página.
- Para fazer comentários sobre o artigo em si, selecione Esta página. Isso leva você a um formulário de Problemas em branco no GitHub, onde você pode começar a preencher seus comentários. Você escolherá essa opção agora.
- Se você quiser examinar outros problemas do GitHub enviados no tópico, selecione Exibir todos os comentários da página. Qualquer pessoa pode ler outros problemas do GitHub em um repositório público, mas se você tiver uma conta do GitHub, também poderá comentar os problemas.
- Selecionar Este produto permite que você forneça comentários sobre o produto em si. Não entraremos em detalhes sobre essa opção por enquanto para que possamos nos concentrar em fornecer comentários sobre a documentação em si.
Depois de selecionar Esta página, você será solicitado a entrar em sua conta do GitHub se ainda não tiver feito isso. Em seguida, um formulário de comentários de problemas em branco aparece no GitHub.
Insira um título para seus comentários que resume brevemente sua entrada.
Na caixa de texto abaixo, descreva seus comentários e forneça qualquer contexto necessário. Use a barra de ferramentas para formatar sua descrição, como adicionar uma citação, lista ou menção.
Quando terminar, selecione Enviar novo problema.
Controlar problemas
O autor do artigo ou outros proprietários de conteúdo serão notificados quando você enviar seu problema. Você pode acompanhar os comentários sobre o problema verificando as notificações do GitHub ou retornando ao repositório e verificando a guia Problemas.
Você também pode explorar, examinar e comentar outros problemas que foram enviados para esse repositório na guia Problemas.
