Beiträge zu technischen Inhalten von NetApp in GitHub
Änderungen vorschlagen
PDFs
Open Source-Dokumentation für die Produkte und Services von NetApp So können Sie einen Beitrag zum Inhalt leisten, indem Sie Verbesserungen, Korrekturen und Vorschläge vornehmen. Alles, was Sie brauchen, ist ein GitHub-Konto und eine kleine Initiative.
Überblick
Sie können über die folgenden Optionen zu unseren Dokumenten beitragen:
-
Wählen Sie doc-Änderungen anfordern, um allgemeines Feedback zu senden oder um eine Frage zum Inhalt zu stellen. Der NetApp Content Lead überprüft anschließend Ihre Anfrage, um festzustellen, welche Änderungen für die Dokumentation erforderlich sind. Dies ist die am häufigsten verwendete Option.
-
Wählen Sie Diese Seite bearbeiten, um den Inhalt direkt selbst zu bearbeiten. Der NetApp Content Lead überprüft anschließend Ihre Änderungen und führt diese zusammen.
Das folgende Video gibt einen kurzen Überblick über diese beiden Optionen.
Die folgenden Abschnitte enthalten Schritt-für-Schritt-Anweisungen.
Änderungen am Dokument anfordern
Die häufigste Möglichkeit, sich an die NetApp Dokumentation zu beteiligen, ist die Einreichung einer Anfrage zur Änderung des DOC-Antrags. Nachdem Sie die Anfrage gesendet haben, bestätigt der Inhaltsleiter, dass Ihr Feedback erhalten wurde. Sie erhalten von GitHub eine E-Mail-Benachrichtigung.
Wenn der Content Lead damit einverstanden ist, dass Ihr Vorschlag den Inhalt besser machen kann, werden sie die Änderung kurz danach begehen. Sie erhalten eine weitere Benachrichtigung, dass Ihr Feedback eingebunden wurde.
|
Alle Kommentare, die Sie angeben, sind öffentlich sichtbar. Jeder, der sich mit den Problemen im GitHub Repo vertraut, kann Ihre Kommentare sehen. |
-
Wenn Sie noch kein GitHub-Konto haben, "Erstellen Sie eine aus github.com"
-
Melden Sie sich bei Ihrem GitHub-Konto an.
-
Öffnen Sie die Seite über Ihren Webbrowser "docs.netapp.com" Dies hängt von Ihrem Feedback ab.
-
Wählen Sie oben auf der Seite Änderungen vorschlagen > Änderungen des Dokuments anfordern.
Eine neue Browser-Registerkarte wird mit einem GitHub-Formular geöffnet, über das Sie Details an unser Doc-Team übermitteln können.
-
Geben Sie einen Titel und eine Zusammenfassung ein, und bestätigen Sie, dass das Problem keine vertraulichen Informationen enthält.
Das Formular wird mit der URL und dem Titel der Seite ausgefüllt. Löschen Sie diese Informationen nicht, da Ihre Anfrage von ihr verstanden werden muss.
-
Wählen Sie Neue Ausgabe senden, um ein Problem für Ihre Anfrage zu erstellen.
Das Öffnen eines Problems ermöglicht die Zusammenarbeit durch GitHub-Kommentare. Sie erhalten E-Mail-Benachrichtigungen basierend auf den Einstellungen, die Sie in Ihren GitHub-Kontoeinstellungen angegeben haben.
Sie können den Status der Anfrage auch anzeigen, indem Sie im GitHub-Banner Ausgaben auswählen:
Bearbeiten Sie die Dokumente
Wenn Sie den Inhalt selbst bearbeiten möchten, können Sie die genauen Dokumentänderungen einreichen, die Sie sehen möchten, indem Sie die Quelldatei direkt bearbeiten.
Als externer Mitarbeiter können Sie die Änderung nicht direkt veröffentlichen. Der Content Lead überprüft die Änderungen, nimmt alle erforderlichen Änderungen vor und führt die Änderungen anschließend zusammen. Wenn dies geschieht, erhalten Sie eine E-Mail-Benachrichtigung von GitHub.
Wenn Sie Hilfe bei unserem Schreibstil oder der Quellsyntax benötigen, können Sie die folgenden Ressourcen verwenden:
-
Wenn Sie noch kein GitHub-Konto haben, "Erstellen Sie eine aus github.com"
-
Melden Sie sich bei Ihrem GitHub-Konto an.
-
Öffnen Sie die Seite über Ihren Webbrowser "docs.netapp.com" Die Sie bearbeiten möchten.
-
Wählen Sie oben auf der Seite Änderungen vorschlagen > Diese Seite bearbeiten.
Eine neue Browser-Registerkarte wird geöffnet und führt Sie zu der Datei im GitHub-Repository für die Dokumentations-Site.
-
Wählen Sie das Bleistiftsymbol.
-
Wenn Sie aufgefordert werden, eine Gabel des Projektarchivs zu erstellen, wählen Sie Dieses Projektarchiv ausgabeln.
-
Bearbeiten Sie den Inhalt.
Der Inhalt ist in AsciiDoc, einer leichten Aufzeichnungssprache, geschrieben. "Erfahren Sie mehr über die Syntax von AsciiDoc".
-
Um Ihre Änderungen zu übernehmen, wählen Sie Änderungen übertragen und füllen Sie das Formular aus:
-
Ändern Sie optional die Standardnachricht für die Übertragung.
-
Fügen Sie eine optionale Beschreibung hinzu.
-
Wählen Sie Änderungen vorschlagen.
-
-
Wählen Sie Pull-Anforderung erstellen.
Nachdem Sie die Änderungen vorgeschlagen haben, werden wir sie überprüfen, alle erforderlichen Änderungen vornehmen und die Änderungen anschließend in das GitHub-Repository zusammenführen.
Sie können den Status der Pull-Anfrage anzeigen, indem Sie Pull Requests aus dem GitHub-Banner auswählen:
