Mitwirken an Azure Linux-Dokumentation

In diesem Artikel wird erläutert, wie Sie zur Azure Linux-Dokumentation beitragen können, indem Sie Fehler beheben, Anleitungen verbessern oder neue Inhalte hinzufügen, die Benutzern bei der Ausführung Azure Linux auf Azure helfen und Anleitungen für unterstützte Azure Linux-Szenarien bieten.

Note

Azure Linux 4.0 befindet sich jetzt in preview und ist streng auf Auswertungs- und Testzwecke beschränkt. Es ist nicht für den Produktionseinsatz geeignet.

Dokumentationsbeiträge im Geltungsumfang

Die Azure Linux-Dokumentation umfasst nur Azure Szenarien, die den Support- und Lebenszyklusverpflichtungen Microsoft entsprechen. Wir pflegen und akzeptieren Beiträge für Inhalte, die Menschen dabei helfen, Azure Linux auf Azure zu verwenden, insbesondere:

• Anleitung für Azure Linux-Virtual Machines (VM) / Virtual Machine Scale Sets (VMSS), AKS und Containerimages.
• Anpassungen, die auf einem vorgefertigten Azure Linux-Image basieren (z. B. mit Image Customizer).

Wenn Ihnen eine Lücke, ein Fehler oder eine Möglichkeit zur Verbesserung der Azure-spezifischen Anleitungen auffällt, teilen Sie uns dies bitte mit.

Beiträge zur Dokumentation außerhalb des Geltungsbereichs

Um die Dokumentation fokussiert und bearbeitbar zu halten, werden die folgenden Arten von Beiträgen geschlossen:

• Inhalte für Szenarien außerhalb der Support- und Lebenszyklusverpflichtungen von Microsoft, einschließlich Bare-Metal-Systemen, ISO-Images, lokalen Umgebungen, anderen Clouds oder Images, die von Grund auf neu aus den Azure Linux-Quellen auf GitHub erstellt wurden.
• Doppelte Inhalte, die wiedergeben, was auf einer anderen Seite bereits vorhanden ist, ohne einen Mehrwert zu bieten.
• Werbliche oder anbieterspezifische Inhalte, die ein bestimmtes Produkt, Werkzeug oder einen bestimmten Dienst außerhalb des Azure Linux-Ökosystems hervorheben.
• Speculative oder nicht überprüfte Anleitungen, die nicht auf einer unterstützten Azure Linux-Konfiguration getestet wurden.
• Umfangreiche unaufgeforderte Umschreibungen, die ohne vorheriges Problem und ohne Genehmigung durch die Verwalter eingereicht werden.

Stil- und Formatierungsrichtlinien

Azure Linux-Dokumentation folgt der Microsoft Lernanleitung zum Dokumentationsstil. Alle Beiträge sollten diesen Standards entsprechen. Pullanforderungen (PRs), die diesen Konventionen nicht entsprechen, werden möglicherweise vor Beginn der Überprüfung zur Überarbeitung zurückgesendet.

Übermitteln Sie eine Änderung an der Dokumentation

Important

Für alle Dokumentationsbeiträge ist zuerst ein Problem erforderlich. Öffnen Sie keine PR ohne ein zugehöriges Problem. PRs ohne verknüpftes Problem können ohne Überprüfung geschlossen werden.

Schritte zum Übermitteln einer Dokumentationsänderung:

1. Öffnen Sie ein Problem. Beschreiben Sie die Lücke, den Fehler oder die Möglichkeit zur Verbesserung. Seien Sie so beschreibend wie möglich; umfassen den Azure Dienst, Azure Linux-Version, Workloadtyp und alle relevanten Kontext- oder Wiedergabeschritte. Warten Sie, bis ein Betreuer das Problem bestätigt, bevor Sie mit der Arbeit beginnen.
2. Suchen Sie nach Duplikaten. Überprüfen Sie vor der Einreichung vorhandene Probleme und PRs, um duplizierte Arbeit zu vermeiden.
3. Abzweigung und Verzweigung. Sobald ein Maintainer das Problem bestätigt, erstellen Sie einen persönlichen Fork des Repositorys und einen Branch mit einem aussagekräftigen Namen (zum Beispiel fix/aks-quickstart-typo oder docs/selinux-recipe).
4. Übermitteln Sie eine PR. Verknüpfen Sie das genehmigte Problem in Ihrer PR-Beschreibung. Halten Sie Ihre Änderungen präzise und aufgabenorientiert. Fügen Sie Kontext wie den Azure Dienst, Azure Linux-Version und den Workloadtyp ein, damit Prüfer Ihren Beitrag auswerten können.
5. Warten Sie auf überprüfung. Ein Maintainer wird Ihre PR prüfen. Seien Sie bereit, änderungen vorzunehmen, wenn sie angefordert werden. Nicht alle PRs werden garantiert zusammengeführt.

Was Sie erwartet, nachdem Sie eine PR eingereicht haben

• Bewertungen erfolgen nach bestem Bemühen. Maintainer prüfen Beiträge je nach verfügbarer Kapazität. Die Reaktionszeiten können variieren und es gibt keine garantierten Vereinbarungen zum Servicelevel (SLAs) für Community-PRs.
• Nicht alle Beiträge werden zusammengeführt. PRs können geschlossen werden, wenn sie nicht in den von Azure unterstützten Umfang fallen, vorhandene Inhalte duplizieren oder nicht der Ausrichtung der Dokumentation entsprechen.
• Möglicherweise werden Sie aufgefordert, etwas zu überarbeiten. Prüfer können Änderungen an Umfang, Genauigkeit oder Formatierung anfordern, bevor eine PR genehmigt werden kann.
• Probleme können ohne Aktion geschlossen werden. Wenn ein Vorgang unvollständig ist, außerhalb des Umfangs liegt oder 30 Tage lang inaktiv ist, kann er geschlossen werden.
• Veraltete PRs werden geschlossen. PRs ohne Aktivität für 30 Tage werden möglicherweise automatisch geschlossen. Sie können erneut öffnen, wenn Sie die Arbeit an der PR fortsetzen möchten.

Verwandte Inhalte

Weitere Informationen zum Beitragen zu Azure Linux finden Sie unter How to contribute to Azure Linux.