Mitwirken an der SQL Server-DokumentationHow to contribute to SQL Server Documentation

GILT FÜR: SQL Server Azure SQL-Datenbank Azure Synapse Analytics (SQL DW) Parallel Data Warehouse

An der SQL Server-Dokumentation kann jeder mitwirken.Anyone can contribute to SQL Server documentation. Beispielsweise können Rechtschreibfehler korrigiert, genauere Erklärungen vorgeschlagen und die technische Richtigkeit geprüft werden.This includes correcting typos, suggesting better explanations, and improving technical accuracy. In diesem Artikel werden die ersten Schritte hierfür beschrieben.This article explains how to get started with content contributions and how the process works.

Wenn Sie zur Dokumentation beitragen möchten, stehen Ihnen zwei Hauptworkflows zur Verfügung:There are two main workflows you can use to contribute:

WorkflowWorkflow BESCHREIBUNGDescription
Bearbeiten von Inhalten im BrowserEdit in your browser Geeignet für kleinere Bearbeitungen eines ArtikelsGood for small, quick edits of any article.
Lokales Bearbeiten von Inhalten mit ToolsEdit locally with tools Geeignet für komplexere Bearbeitungen in mehreren Artikeln und bei häufigen Beiträgen für docs.microsoft.comGood for more complex edits, edits involving multiple articles, and frequent contributions to docs.microsoft.com.

Alle öffentlichen Beiträge werden vom SQL-Inhaltsteam auf technische Richtigkeit und Konsistenz geprüft.All public contributions are validated by the SQL content team for technical accuracy and consistency.

Bearbeiten von Inhalten im BrowserEdit in your browser

Sie können im Browser einfache Änderungen an SQL Server-Inhalten vornehmen und diese dann an Microsoft übermitteln.You can make simple edits to SQL Server content in your browser and then submit them to Microsoft. Weitere Informationen finden Sie im Leitfaden für Mitwirkende der Microsoft-Dokumentation: Übersicht.For more information, you can see the Microsoft Docs contributor guide overview.

Die folgenden Schritte fassen den Prozess zusammen:The following steps summarize the process:

  1. Wählen Sie auf der Seite, zu der Sie Feedback übermitteln möchten, oben rechts den Link Bearbeiten aus.On the page you have feedback about, select the Edit link at the top right.
  2. Wählen Sie auf der nächsten Seite oben rechts das Symbol Stift aus.On the next page, select the Pencil icon at the top right.
  3. Nehmen Sie auf der nächsten Seite im Textfenster Datei bearbeiten Ihre Änderungen direkt an dem Text vor, den Sie ändern möchten.On the next page, in the Edit file text window, make your edits directly to the text you want to change. Wenn Sie Hilfe beim Formatieren des neuen oder geänderten Texts benötigen, sehen Sie sich den „Spickzettel“ zum Markdown an.If you need help with formatting the new or changed text, see the Markdown Cheatsheet.
  4. Nachdem Sie Ihre Änderungen vorgenommen haben, gehen Sie unter Änderungen vornehmen folgendermaßen vor:After you've made your edits, under Commit changes:
    1. Geben Sie im ersten Textfeld eine kurze Beschreibung der Änderung ein, die Sie vorgenommen haben.In the first text box, enter a brief description of the change you've made.
    2. Geben Sie im Feld Eine optionale erweiterte Beschreibung hinzufügen eine kurze Erläuterung Ihrer Änderung an.In the Add an optional extended description box, provide a brief explanation of your change.
  5. Wählen Sie Dateiänderung vorschlagen aus.Select Propose file change.
  6. Wählen Sie auf der Seite Änderungen werden verglichen die Option Pull Request erstellen aus.On the Comparing changes page, select Create pull request.
  7. Wählen Sie auf der Seite Pull Request öffnen die Option Pull Request erstellen aus.On the Open a pull request page, select Create pull request.

Die folgende GIF-Datei veranschaulicht den gesamten Ablauf zur Übermittlung von Änderungen in Ihrem Browser:The following GIF demonstrates the end-to-end process for submitting changes in your browser:

SQL-Dokumentation bearbeiten

Lokales Bearbeiten von Inhalten mit ToolsEdit locally with tools

Eine weitere Bearbeitungsoption besteht darin, das sql-docs- oder azure-docs-Repository zu forken und es lokal auf dem Computer zu klonen.Another editing option is to fork the sql-docs or azure-docs repositories and clone it locally to your machine. Anschließend können Sie mithilfe eines Markdown-Editors und eines Git-Clients die Änderungen übermitteln.You can then use a Markdown editor and a git client to submit the changes. Dieser Workflow eignet sich für Bearbeitungen, die komplexer sind oder mehrere Dateien betreffen.This workflow is good for edits that are more complex or involve multiple files. Außerdem ist er gut für Mitwirkende geeignet, die häufig Beiträge bei docs.microsoft.com einreichen.It is also good for frequent contributors to docs.microsoft.com.

Weitere Informationen zu dieser Bearbeitungsoption finden Sie in den folgenden Artikeln:To contribute with this method, see the following articles:

Wenn Sie einen Pull Request mit umfassenden Änderungen an der Dokumentation einreichen, wird in GitHub ein Kommentar angezeigt, in dem Sie aufgefordert werden, online eine Lizenzvereinbarung für Mitwirkende zu übermitteln.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). Sie müssen dieses Onlineformular ausfüllen, damit Ihr Pull Request akzeptiert wird.You must complete the online form before your pull request can be accepted.

ErkennungRecognition

Nachdem Ihre Änderungen akzeptiert wurden, werden Sie am Anfang des Artikels als Mitwirkender genannt.If your changes are accepted, you are recognized as a contributor at the top of the article.

Nennung als Mitwirkender bei Einreichung von Inhaltsänderungen

Übersicht über sql-docssql-docs overview

Dieser Abschnitt enthält zusätzliche Hinweise zur Arbeit mit dem sql-docs-Repository.This section provides some additional guidance on working in the sql-docs repository.

Wichtig

Diese beziehen sich ausschließlich auf sql-docs. Wenn Sie stattdessen einen SQL-Artikel der Azure-Dokumentation bearbeiten, finden Sie auf GitHub in der Infodatei des azure-docs-Repositorys weitere Informationen.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.

Zur Organisation von Inhalten werden im sql-docs-Repository die folgenden Standardordner verwendet:The sql-docs repository uses several standard folders to organize the content.

OrdnerFolder BESCHREIBUNGDescription
docsdocs Enthält alle veröffentlichten SQL Server-Inhalte.Contains all published SQL Server content. In Unterordnern werden verschiedene Inhaltsbereiche organisiert.Subfolders logically organize different areas of the content.
docs/includesdocs/includes Enthält Includedateien.Contains include files. Diese Dateien bestehen aus Inhaltsblöcken, die in ein oder mehrere Artikel aufgenommen werden können.These files are blocks of content that can be included in one or more other topics.
./media./media Jeder Ordner kann über einen media-Unterordner für Artikelbilder verfügen.Each folder can have one media subfolder for article images. Der media-Ordner enthält wiederum Unterordner mit denselben Namen der Artikel, in denen die Bilder angezeigt werden.The media folder in turn has subfolders with the same name as the topics that the image appears in. Bei den Bildern sollte es sich um PNG-Dateien handeln, deren Dateinamen aus Kleinbuchstaben bestehen und keine Leerzeichen enthalten.Images should be .png files with all lower-case letters and no spaces.
TOC.MDTOC.MD Eine Inhaltsverzeichnisdatei.A table-of-contents file. In jedem Unterordner kann eine TOC.MD-Datei verwendet werden.Each subfolder has the option of using one TOC.MD file.

applies-to-IncludedateienApplies-to includes

In jedem SQL Server-Artikel befindet sich nach dem Titel ein Verweis auf die applies-to-Includedatei.Each SQL Server article contains an applies-to include file after the title. Damit wird angegeben, auf welche Bereiche oder Versionen von SQL Server sich der Artikel bezieht.This indicates what areas or versions of SQL Server the article applies to.

Im folgenden Markdown-Beispiel wird die Includedatei appliesto-ss-asdb-asdw-pdw-md.md abgerufen.Consider the following Markdown example that pulls in the appliesto-ss-asdb-asdw-pdw-md.md include file.

[!INCLUDE[SQL Server Azure SQL Database Synapse Analytics PDW ](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]

Dadurch wird der folgende Text am Anfang des Artikels angezeigt:This adds the following text at the top of the article:

applies-to-Text

Mit den folgenden Tipps finden Sie die richtige applies-to-Includedatei für Ihren Artikel:To find the correct applies-to include file for your article, use the following tips:

  • Eine Liste häufig verwendeter Includedateien finden Sie unter SQL Server-Includedateien für die Versionsverwaltung und „Applies-to“.For a list of commonly used includes, see SQL Server version and applies-to include files.
  • Suchen Sie nach anderen Artikeln, in denen es um dasselbe Feature oder um eine vergleichbare Aufgabe geht.Look at other articles that cover the same feature or a related task. Wenn Sie diese Artikel bearbeiten, können Sie das Markdown-Element für den Link zur applies-to-Includedatei kopieren. Dabei können Sie die Bearbeitung abbrechen, ohne die Änderungen zu senden.If you edit that article, you can copy the Markdown for the applies-to include link (you can cancel the edit without submitting it).
  • Durchsuchen Sie das Verzeichnis docs/includes nach Dateien, die den Text „applies-to“ enthalten.Search the docs/includes directory for files containing the text "applies-to". Über die Schaltfläche Find (Suchen) können Sie in GitHub die Ergebnisse schnell filtern.You can use the Find button in github to quickly filter. Klicken Sie auf die Datei, um festzustellen, wie diese gerendert wird.Click on the file to see how it is rendered.
  • Beachten Sie die Namenskonvention.Pay attention to the naming convention. Wenn der Name mehrmals den Buchstaben „x“ enthält, ist dieser vermutlich ein Platzhalter, der darauf hinweist, dass ein bestimmter Dienst nicht unterstützt wird.If there are x's in the name, they are usually placeholders indicating the lack of support for a service. Durch appliesto-xx-xxxx-asdw-xxx-md.md wird beispielsweise angegeben, dass ausschließlich Azure Synapse Analytics unterstützt wird, da nur die Zeichenfolge asdw vorhanden ist. Die anderen Felder enthalten hingegen nur den Buchstaben „x“.For example, appliesto-xx-xxxx-asdw-xxx-md.md indicates support for only Azure Synapse Analytics, because only asdw is spelled out, whereas the other fields have x's.
  • In einigen Includedateien werden Versionsnummern wie tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md angegeben.Some includes specify a version number, such as tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Verwenden Sie diese Includedateien nur, wenn Sie wissen, dass dieses Feature mit einer bestimmten Version von SQL Server eingeführt wurde.Only use these includes when you know the feature was introduced with a specific version of SQL Server.

Ressourcen für MitwirkendeContributor resources

Tipp

Wenn Sie nicht Feedback zur Dokumentation, sondern zu einem SQL Server-Produkt geben möchten, können Sie die hierfür eingerichtete Seite nutzen.If you have product feedback rather than documentation feedback, provide feedback on the SQL Server product here.

Nächste SchritteNext steps

Auf GitHub können Sie einen genaueren Blick auf das sql-docs-Repository werfen.Explore the sql-docs repository on GitHub.

Außerdem haben Sie die Möglichkeit, Artikel zu suchen, Änderungen einzureichen und die SQL Server-Community zu unterstützen.Find an article, submit a change, and help the SQL Server community.

Vielen Dank!Thank you!