Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Gilt für:
SQL ServerAzure SQL-DatenbankAzure Synapse AnalyticsAnalytics Platform System (PDW)
An der SQL Server-Dokumentation kann jeder mitwirken. Beispielsweise können Rechtschreibfehler korrigiert, genauere Erklärungen vorgeschlagen und die technische Richtigkeit geprüft werden. In diesem Artikel wird erklärt, wie Sie mit Inhaltsbeiträgen beginnen und wie der Prozess funktioniert.
Es gibt zwei Hauptworkflows, die Sie für Ihre Beiträge verwenden können:
| Arbeitsablauf | BESCHREIBUNG |
|---|---|
| Bearbeiten von Inhalten im Browser | Geeignet für kleinere Bearbeitungen eines Artikels |
| Lokales Bearbeiten von Inhalten mit Tools | Geeignet für komplexere Bearbeitungen, Bearbeitungen, die mehrere Artikel betreffen, und häufige Beiträge. |
Das Inhaltsteam für Data Docs überprüft alle öffentlichen Beiträge auf technische Genauigkeit und Konsistenz.
Bearbeiten von Inhalten im Browser
Sie können im Browser einfache Änderungen an SQL Server-Inhalten vornehmen und diese dann an Microsoft übermitteln. Weitere Informationen finden Sie im Leitfaden für Mitwirkende: Übersicht.
Die folgenden Schritte fassen den Prozess zusammen:
- Wählen Sie auf der Seite, für die Sie eine Änderung vorschlagen möchten, den Kebab (drei vertikale Punkte) in der Nähe in diesem Artikel aus.
- Wählen Sie Bearbeiten aus. Der Browser führt Sie zum GitHub-Repository für diese Artikelquelldatei.
- Wählen Sie in der Quelldatei oben rechts das Bleistiftsymbol aus. Wenn dieses Symbol nicht angezeigt wird, müssen Sie sich gegebenenfalls zuerst bei Ihrem GitHub-Konto anmelden. GitHub gibt die Bearbeitungsseite zurück.
- Bearbeiten Sie den Text, um Änderungen vorzuschlagen. Wenn Sie Hilfe beim Formatieren des neuen oder geänderten Texts benötigen, sehen Sie sich den „Spickzettel“ zum Markdown an.
- Nachdem Sie Ihre Änderungen vorgenommen haben, scrollen Sie zurück zum Anfang der Seite, und wählen Sie Commit-Änderungen aus.
- Geben Sie im Dialogfeld "Commit-Nachricht ausführen " einen Namen für Ihre Pullanforderung an, z. B. "Tippfehler korrigieren".
- Geben Sie im Feld Eine optionale erweiterte Beschreibung hinzufügen eine kurze Erläuterung Ihrer Änderung an.
- Wählen Sie " Änderungen vorschlagen" aus, um zur Seite " Änderungen vergleichen" zu wechseln.
- Wählen Sie auf der Seite "Änderungen vergleichen " die Option " Pullanforderung erstellen " aus, um zur Seite " Pullanforderung öffnen " zu wechseln.
- Wählen Sie auf der Seite "Pullanforderung öffnen" die Option " Pullanforderung erstellen" aus, um Ihre Pull-Anforderung an das Inhaltsteam zu übermitteln.
Die folgende GIF-Datei veranschaulicht den gesamten Ablauf zur Übermittlung von Änderungen in Ihrem Browser:
Nachdem Sie Ihre Pull-Anforderung erstellt haben, überprüft das Inhaltsteam Ihre vorgeschlagenen Änderungen. Wenn sie Ihre Änderungen akzeptieren, führen sie sie in die Dokumentation ein und veröffentlichen sie. Sie erhalten E-Mail-Benachrichtigungen über den Status Ihrer Pull-Anforderung, abhängig von Ihren Github-Benachrichtigungseinstellungen.
Lokal mithilfe von Tools bearbeiten
Eine weitere Möglichkeit besteht darin, einen Fork des sql-docs- oder azure-docs-Repositories zu erstellen und dieses lokal auf Ihren Computer zu klonen. Anschließend können Sie mithilfe eines Markdown-Editors und eines Git-Clients die Änderungen übermitteln. Dieser Workflow eignet sich für Bearbeitungen, die komplexer sind oder mehrere Dateien betreffen. Er ist auch gut für häufige Mitwirkende an technischer Microsoft-Dokumentation geeignet.
Um mit dieser Methode beizutragen, lesen Sie die folgenden Artikel:
- Einrichten eines GitHub-Kontos
- Install content authoring tools (Installieren von Erstellungstools für Inhalte)
- Ein lokales Git-Repository einrichten
- Tools zum Beitragen verwenden
Wenn Sie eine Pull-Anforderung mit erheblichen Änderungen an der Dokumentation einreichen, erhalten Sie einen Kommentar in GitHub, der Sie auffordert, einen Onlinebeitragslizenzvertrag (CLA) einzureichen. Sie müssen dieses Onlineformular ausfüllen, damit Ihr Pull Request akzeptiert wird.
Übersicht: sql-docs-Repository
Dieser Abschnitt enthält weitere Hinweise zur Arbeit im sql-docs-Repository.
Wichtig
Die Informationen in diesem Abschnitt beziehen sich ausschließlich auf sql-docs. Wenn Sie einen SQL-Artikel in der Azure-Dokumentation bearbeiten, finden Sie auf GitHub in der Infodatei des azure-docs-Repositorys weitere Informationen.
Zur Organisation von Inhalten werden im sql-docs-Repository die folgenden Standardordner verwendet:
| Ordner | BESCHREIBUNG |
|---|---|
| Dokumentationen | Enthält alle veröffentlichten SQL Server-Inhalte. Unterordner ordnen verschiedene Inhaltsbereiche logisch. |
| Docs/includes | Enthält Include-Dateien. Diese Dateien bestehen aus Inhaltsblöcken, die in ein oder mehrere andere Artikel aufgenommen werden können. |
./media |
Jeder Ordner kann über einen media-Unterordner für Artikelbilder verfügen. Der media-Ordner enthält wiederum Unterordner mit denselben Namen der Artikel, in denen die Bilder angezeigt werden. Bilder sollten Dateien mit allen Kleinbuchstaben und ohne Leerzeichen sein .png . |
TOC.yml |
Eine Inhaltsverzeichnisdatei. Jeder Unterordner hat die Möglichkeit, eine TOC.yml Datei zu verwenden. |
Ressourcen für Mitwirkende
Tipp
Wenn Sie Feedback zum Produkt statt zur Dokumentation haben, geben Sie Feedback.
Nächster Schritt
Außerdem haben Sie die Möglichkeit, Artikel zu suchen, Änderungen einzureichen und die SQL Server-Community zu unterstützen.