Compartilhar via

Como contribuir com a documentação do SQL Server

Aplica-se a:SQL ServerBanco de Dados SQL do AzureAzure Synapse AnalyticsPDW (Analytics Platform System)

Qualquer pessoa pode contribuir para a documentação do SQL Server. Isso inclui corrigir erros de digitação, sugerir melhores explicações e melhorar a precisão técnica. Este artigo explica como começar com as contribuições de conteúdo e como o processo funciona.

Há dois fluxos de trabalho principais que você pode usar para contribuir:

Workflow Descrição
Editar no navegador Bom para edições simples e breves de qualquer artigo.
Editar localmente com ferramentas Bom para edições mais complexas, edições que envolvem vários artigos e contribuições frequentes.

A equipe de conteúdo do Data Docs valida todas as contribuições públicas para precisão técnica e consistência.

Editar no navegador

Você pode fazer edições simples no conteúdo do SQL Server em seu navegador e, em seguida, enviá-las à Microsoft. Para obter mais informações, confira o guia do colaborador do Microsoft Docs.

O processo é resumido pelas seguintes etapas:

  1. Na página na qual você deseja sugerir uma alteração, selecione o Kebab (três pontos verticais) próximo a neste artigo.
  2. Selecione Editar. O navegador leva você ao repositório GitHub para esse arquivo de origem do artigo.
  3. No arquivo de origem, selecione o ícone Lápis na parte superior direita. Se esse ícone não aparecer, talvez seja necessário entrar na conta do GitHub primeiro. O GitHub retorna a página de edição.
  4. Edite o texto para propor alterações. Se precisar de ajuda com a formatação do texto novo ou alterado, consulte a Folha de Referências de Markdown.
  5. Depois de fazer suas edições, role para trás até a parte superior da página e selecione Confirmar alterações.
    1. Na caixa de diálogo Confirmar mensagem , forneça um nome para sua solicitação de pull, como Corrigir erro de digitação.
    2. Na caixa Adicionar uma descrição estendida opcional, forneça uma breve explicação de sua alteração.
    3. Selecione Propor alterações para ir para a página Comparando alterações .
  6. Na página Comparando alterações , selecione Criar solicitação de pull para ir para a página Abrir uma solicitação de pull .
  7. Na página Abrir uma solicitação de pull, selecione Criar solicitação de pull para enviar sua solicitação de pull para a equipe de conteúdo.

O seguinte GIF mostra o processo de ponta a ponta para enviar as alterações ao seu navegador:

Captura de tela do editor de documentos SQL.

Depois de criar sua solicitação de pull, a equipe de conteúdo examinará as alterações propostas. Se eles aceitarem suas alterações, elas as mesclarão na documentação e as publicarão. Você recebe notificações por email sobre o status da solicitação de pull, dependendo das configurações de notificação do Github.

Editar localmente usando ferramentas

Outra opção é bifurcar o repositório sql-docs ou azure-docs e cloná-lo localmente em seu computador. Dessa forma, você poderá usar um editor de Markdown e um cliente git para enviar as alterações. Este fluxo de trabalho é bom para edições mais complexas ou que envolvem vários arquivos. Ele também é bom para colaboradores frequentes para a documentação técnica da Microsoft.

Para contribuir com esse método, consulte os seguintes artigos:

Se você enviar uma solicitação pull com alterações significativas na documentação, receberá um comentário no GitHub que solicita que você envie um CLA (Contrato de Licença de Contribuição) online. É necessário preencher o formulário online para que sua solicitação de pull seja aceita.

Visão geral: repositório sql-docs

Esta seção fornece mais orientações sobre como trabalhar no repositório sql-docs.

Importante

As informações desta seção são específicas para sql-docs. Se você estiver editando um artigo do SQL na documentação do Azure, veja o Leiame do repositório azure-docs no GitHub.

O repositório sql-docs usa várias pastas padrão para organizar o conteúdo.

Pasta Descrição
documentos Contém todo o conteúdo publicado do SQL Server. As subpastas organizam logicamente as diferentes áreas do conteúdo.
docs/includes Contém arquivos include. Esses arquivos são blocos de conteúdo que pode ser incluído em um ou mais artigos.
./media Cada pasta pode ter uma subpasta media para imagens do artigo. A pasta media, por sua vez, tem subpastas com o mesmo nome que os artigos nos quais a imagem aparece. As imagens devem ser .png arquivos com todas as letras minúsculas e sem espaços.
TOC.yml Um arquivo de índice. Cada subpasta tem a opção de usar um TOC.yml arquivo.

Recursos do colaborador

Dica

Se você tiver comentários sobre o produto em vez de comentários de documentação, forneça comentários.

Próxima etapa

Explore o repositório sql-docs no GitHub.

Localize um artigo, envie uma alteração e ajude a comunidade do SQL Server.

Obrigado.

  • Last updated on