Freigeben über

Beitragen zur PowerShell-Dokumentation

Vielen Dank für Ihre Unterstützung von PowerShell!

Der Leitfaden für Mitwirkende ist eine Sammlung von Artikeln, die die Tools und Prozesse beschreiben, die wir zum Erstellen von Dokumentationen bei Microsoft verwenden. Einige dieser Leitfäden enthalten Informationen, die für alle Dokumentationssätze, die zu learn.microsoft.com veröffentlicht werden, relevant sind. Andere Leitfäden sind spezifisch für das Schreiben der Dokumentation für PowerShell.

Die allgemeinen Artikel sind in unserem zentralen Mitwirkendenhandbuch verfügbar. Die PowerShell-spezifischen Leitfäden sind hier verfügbar.

Möglichkeiten zur Mitwirkung

Es gibt zwei Möglichkeiten, mitzuwirken. Beide Beiträge sind für uns wertvoll.

  • Das Melden von Problemen hilft uns, Probleme und Lücken in unserer Dokumentation zu erkennen. Manchmal sind die Probleme schwer zu lösen, was mehr Untersuchung und Forschung erfordert. Der Problemprozess ermöglicht es uns, ein Gespräch über das Problem zu führen und eine zufriedenstellende Lösung zu entwickeln.

  • Das Übermitteln einer Pullanforderung zum Hinzufügen oder Ändern von Inhalten ist ein komplexerer Prozess. In den folgenden Informationen werden die Tools, Prozesse und Standards zum Übermitteln von Inhalten an die Dokumentation beschrieben.

Bereiten Sie sich darauf vor, einen Beitrag zu leisten

Für den Beitrag zur Dokumentation ist ein GitHub-Konto erforderlich. Verwenden Sie die folgende Checkliste, um die Tools zu installieren und zu konfigurieren, die Sie zum Erstellen von Beiträgen benötigen.

  1. Registrieren für GitHub
  2. Installieren von Git- und Markdown-Tools
  3. Installieren des Dokumenterstellungspakets
  4. Posh-Git installieren - nicht erforderlich, aber empfohlen
  5. Einrichten eines lokalen Git-Repositorys
  6. Überprüfen von Git- und GitHub-Grundlagen

Erste Schritte mit dem Schreiben von Dokumentation

Es gibt zwei Möglichkeiten, änderungen an der Dokumentation beizutragen:

  1. Schnelle Bearbeitungen an vorhandenen Dokumenten – Kleinere Korrekturen, Korrigieren von Tippfehlern oder kleine Ergänzungen
  2. Vollständiger GitHub-Workflow für Dokumente – große Änderungen, mehrere Versionen, Hinzufügen oder Ändern von Bildern oder Beiträge zu neuen Artikeln

Lesen Sie außerdem den Abschnitt "Schreibgrundlagen" des zentralen Mitwirkenden-Leitfadens. Eine weitere hervorragende Ressource ist das Microsoft Writing Style Guide.

Kleinere Korrekturen oder Klarstellungen für Dokumentationen und Codebeispiele in öffentlichen Repositorys unterliegen den learn.microsoft.com Nutzungsbedingungen.

Verwenden Sie den vollständigen GitHub-Workflow, wenn Sie erhebliche Änderungen vornehmen. Wenn Sie kein Mitarbeiter von Microsoft sind, fügt unser PR-Validierungssystem der Pull-Anforderung einen Kommentar hinzu, der Sie auffordert, den Lizenzvertrag für Onlinebeiträge (CLA) zu unterzeichnen. Sie müssen diesen Schritt ausführen, bevor wir Ihre Pull-Anforderung überprüfen oder akzeptieren können. Das Signieren der CLA ist nur erforderlich, wenn Sie zum ersten Mal eine PR im Repository einreichen. Möglicherweise werden Sie aufgefordert, die CLA jedes Mal zu signieren, wenn Sie zu einem neuen Repository beitragen.

Verhaltenskodex

Alle Repositories, die Inhalte auf Microsoft Learn veröffentlichen, befolgen den Microsoft Open Source Code of Conduct oder den .NET Foundation Code of Conduct. Weitere Informationen finden Sie in den Häufig gestellten Fragen zum Verhaltenskodex.

Nächste Schritte

Die folgenden Artikel beziehen sich auf Informationen speziell für die PowerShell-Dokumentation. Wo sich die Anleitungen im Leitfaden für zentrale Mitwirkende überschneiden, wird erläutert, wie sich diese Regeln für den PowerShell-Inhalt unterscheiden.

Lesen Sie die folgenden Dokumente:

Weitere Ressourcen

  • Last updated on