Como contribuir para a documentação do SQL ServerHow to contribute to SQL Server Documentation

APLICA-SE A: simSQL Server simBanco de Dados SQL do Azure simAzure Synapse Analytics (SQL DW) simParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database yesAzure Synapse Analytics (SQL DW) yesParallel Data Warehouse

Qualquer pessoa pode contribuir para a documentação do SQL Server.Anyone can contribute to SQL Server documentation. Isso inclui corrigir erros de digitação, sugerir melhores explicações e melhorar a precisão técnica.This includes correcting typos, suggesting better explanations, and improving technical accuracy. Este artigo explica como começar com as contribuições de conteúdo e como o processo funciona.This article explains how to get started with content contributions and how the process works.

Há dois fluxos de trabalho principais que você pode usar para contribuir:There are two main workflows you can use to contribute:

Editar no navegadorEdit in your browser Bom para edições simples e breves de qualquer artigo.Good for small, quick edits of any article.
Editar localmente com ferramentasEdit locally with tools Bom para edições mais complexas, edições que envolvem vários artigos e contribuições frequentes para docs.microsoft.com.Good for more complex edits, edits involving multiple articles, and frequent contributions to docs.microsoft.com.

Todas as contribuições públicas são validadas pela equipe de conteúdo do SQL para exatidão técnica e consistência.All public contributions are validated by the SQL content team for technical accuracy and consistency.

Editar no navegadorEdit in your browser

Você pode fazer edições simples no conteúdo do SQL Server em seu navegador e, em seguida, enviá-las à Microsoft.You can make simple edits to SQL Server content in your browser and then submit them to Microsoft. Para saber mais, confira o Guia de visão geral do colaborador do Microsoft Docs.For more information, you can see the Microsoft Docs contributor guide overview.

O processo é resumido pelas seguintes etapas:The following steps summarize the process:

  1. Na página sobre a qual você tem comentários, selecione o link Editar no canto superior direito.On the page you have feedback about, select the Edit link at the top right.
  2. Na página seguinte, selecione o ícone de Lápis no canto superior direito.On the next page, select the Pencil icon at the top right.
  3. Na página seguinte, na janela de texto Editar arquivo, faça suas edições diretamente no texto que deseja alterar.On the next page, in the Edit file text window, make your edits directly to the text you want to change. Se precisar de ajuda com a formatação do texto novo ou alterado, consulte a Folha de Referências de Markdown.If you need help with formatting the new or changed text, see the Markdown Cheatsheet.
  4. Depois de fazer suas edições, em Confirmar alterações:After you've made your edits, under Commit changes:
    1. Na primeira caixa de texto, insira uma breve descrição da alteração feita.In the first text box, enter a brief description of the change you've made.
    2. Na caixa Adicionar uma descrição estendida opcional, forneça uma breve explicação de sua alteração.In the Add an optional extended description box, provide a brief explanation of your change.
  5. Selecione Propor alteração de arquivo.Select Propose file change.
  6. Na página Comparando alterações, selecione Criar solicitação de pull.On the Comparing changes page, select Create pull request.
  7. Na página Abrir solicitação de pull, selecione Criar solicitação de pull.On the Open a pull request page, select Create pull request.

O seguinte GIF mostra o processo de ponta a ponta para enviar as alterações ao seu navegador:The following GIF demonstrates the end-to-end process for submitting changes in your browser:

Editar documentos do SQL

Editar localmente com ferramentasEdit locally with tools

Outra opção de edição é criar fork nos repositórios sql-docs ou azure-docs e cloná-los localmente para seu computador.Another editing option is to fork the sql-docs or azure-docs repositories and clone it locally to your machine. Dessa forma, você poderá usar um editor de Markdown e um cliente git para enviar as alterações.You can then use a Markdown editor and a git client to submit the changes. Este fluxo de trabalho é bom para edições mais complexas ou que envolvem vários arquivos.This workflow is good for edits that are more complex or involve multiple files. Também é bom para colaboradores frequentes do docs.microsoft.com.It is also good for frequent contributors to docs.microsoft.com.

Para contribuir com esse método, consulte os seguintes artigos:To contribute with this method, see the following articles:

Se enviar uma solicitação de pull com alterações significativas na documentação, você receberá um comentário no GitHub solicitando o envio de um CLA (contrato de licença de contribuição) online.If you submit a pull request with significant changes to documentation, you will get a comment in GitHub asking you to submit an online Contribution License Agreement (CLA). É necessário preencher o formulário online para que sua solicitação de pull seja aceita.You must complete the online form before your pull request can be accepted.

ReconhecimentoRecognition

Se as alterações forem aceitas, você será reconhecido como um colaborador na parte superior do artigo.If your changes are accepted, you are recognized as a contributor at the top of the article.

Reconhecimento de contribuição de conteúdo

Visão geral de sql-docssql-docs overview

Esta seção fornece algumas diretrizes adicionais sobre como trabalhar no repositório sql-docs.This section provides some additional guidance on working in the sql-docs repository.

Importante

As informações nesta seção são específicas para o 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.The information in this section is specific to sql-docs. If you are editing a SQL article in the Azure documentation, see the Readme for the azure-docs repository on GitHub.

O repositório sql-docs usa várias pastas padrão para organizar o conteúdo.The sql-docs repository uses several standard folders to organize the content.

PastaFolder DescriçãoDescription
docsdocs Contém todo o conteúdo publicado do SQL Server.Contains all published SQL Server content. As subpastas organizam logicamente as diferentes áreas do conteúdo.Subfolders logically organize different areas of the content.
docs/includesdocs/includes Contém arquivos include.Contains include files. Esses arquivos são blocos de conteúdo que pode ser incluído em um ou mais tópicos.These files are blocks of content that can be included in one or more other topics.
./media./media Cada pasta pode ter uma subpasta media para imagens do artigo.Each folder can have one media subfolder for article images. A pasta media, por sua vez, tem subpastas com o mesmo nome que os tópicos nos quais a imagem aparece.The media folder in turn has subfolders with the same name as the topics that the image appears in. As imagens devem ser arquivos .png com todas as letras minúsculas e sem espaços.Images should be .png files with all lower-case letters and no spaces.
TOC.MDTOC.MD Um arquivo de índice.A table-of-contents file. Cada subpasta tem a opção de usar um arquivo TOC.MD.Each subfolder has the option of using one TOC.MD file.

Includes Applies-toApplies-to includes

Cada artigo do SQL Server contém um arquivo include applies-to após o título.Each SQL Server article contains an applies-to include file after the title. Isso indica a quais áreas ou versões do SQL Server o artigo se aplica.This indicates what areas or versions of SQL Server the article applies to.

Considere o seguinte exemplo de Markdown que efetua pull no arquivo include appliesto-ss-asdb-asdw-pdw-md.md.Consider the following Markdown example that pulls in the appliesto-ss-asdb-asdw-pdw-md.md include file.

[!INCLUDE[appliesto-ss-asdb-asdw-pdw-md](../includes/appliesto-ss-asdb-asdw-pdw-md.md)]

Isso adiciona o seguinte texto à parte superior do artigo:This adds the following text at the top of the article:

Texto do Applies to

Para encontrar o arquivo include applies-to correto para o artigo, use as dicas a seguir:To find the correct applies-to include file for your article, use the following tips:

  • Para obter uma lista dos includes mais usados, veja Versão do SQL Server e arquivos do include applies-to.For a list of commonly used includes, see SQL Server version and applies-to include files.
  • Examine outros artigos que abordam o mesmo recurso ou uma tarefa relacionada.Look at other articles that cover the same feature or a related task. Se você editar esse artigo, poderá copiar o Markdown para o link do include applies-to (será possível cancelar a edição sem enviá-la).If you edit that article, you can copy the Markdown for the applies-to include link (you can cancel the edit without submitting it).
  • Pesquise no diretório docs/includes para arquivos que contém o texto “applies-to”.Search the docs/includes directory for files containing the text "applies-to". Você pode usar o botão Localizar no github filtrar rapidamente.You can use the Find button in github to quickly filter. Clique no arquivo para ver como ele é renderizado.Click on the file to see how it is rendered.
  • Atente-se à convenção de nomenclatura.Pay attention to the naming convention. Se não houver letras x no nome, geralmente tratam-se de espaços reservados que indicam a falta de suporte para um serviço.If there are x's in the name, they are usually placeholders indicating the lack of support for a service. Por exemplo, appliesto-xx-xxxx-asdw-xxx-md.md indica suporte apenas para o SQL Data Warehouse do Azure, porque somente asdw está escrito, enquanto os outros campos mostram letras x.For example, appliesto-xx-xxxx-asdw-xxx-md.md indicates support for only Azure SQL Data Warehouse, because only asdw is spelled out, whereas the other fields have x's.
  • Alguns deles incluem um número de versão específica, como tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md.Some includes specify a version number, such as tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Use esses includes somente se você conhecer o recurso que foi introduzido em uma versão específica do SQL Server.Only use these includes when you know the feature was introduced with a specific version of SQL Server.

Recursos do colaboradorContributor resources

Dica

Se você tiver comentários sobre o produto, em vez de comentários sobre a documentação, deixe seus comentários sobre o produto SQL Server aqui.If you have product feedback rather than documentation feedback, provide feedback on the SQL Server product here.

Próximas etapasNext steps

Explore o repositório sql-docs no GitHub.Explore the sql-docs repository on GitHub.

Localize um artigo, envie uma alteração e ajude a comunidade do SQL Server.Find an article, submit a change, and help the SQL Server community.

Obrigado.Thank you!