Anleitung Prozess
Auf dieser Seite erfährst du mehr über den Prozess, wie du zu unseren ZAP-Docs beiträgst. Der Prozess wird auf dieser Seite in chronologischer Reihenfolge beschrieben, daher empfehlen wir, hier zu beginnen.
Schritt 1: Inhalte vorschlagen
Der erste Teil des Prozesses besteht darin, einen Vorschlag über unser GitHub-Repository zu erstellen. Du musst uns genau beschreiben, welche Änderungen und Verbesserungen du vorschlägst.
Achte bitte darauf, dass deine Idee kein Duplikat eines bestehenden Anleitungs oder Vorschlags ist und dass du fest davon überzeugt bist, dass sie für Anfänger oder fortgeschrittene Nutzer nützlich ist. Vorhandene Vorschläge kannst du auf der Issues Page einsehen.
Wir empfehlen, unsere Guidelines Page zu lesen, um den Inhalt und den Dokumentationsstil zu verstehen, den wir verfolgen.
Nach welchen Themen suchen wir?
Für unsere Anleitungen suchen wir ein breites Spektrum an praktischen und qualitativ hochwertigen Anleitungen zu Produkten, Dienstleistungen und Open-Source-Software, die über ZAP-Hosting verfügbar sind oder sich auf einen unserer Dienste beziehen. Wenn du ein paar Ideen oder Inspirationen brauchst, schau dir unsere Seiten in den ZAP-Docs an, um ein Gefühl für unseren Schreibstil und die Art der Inhalte zu bekommen, die wir veröffentlichen.
Wie bereits in der Einführung erwähnt, müssen alle Inhalte, die wir erstellen, original sein, um die Urheberrechtsgesetze einzuhalten. Jegliche unerlaubte Nutzung von KI/generativen Tools und/oder anderem geistigen Eigentum ist strengstens untersagt. Unsere Anleitungen zielen darauf ab, qualitativ hochwertige Informationen durch eine Reihe von Schritten zu liefern, um sicherzustellen, dass die Leser/innen verstehen, was sie tun und wie sie es tun können, mit dem Ziel, die Leser/innen aufzuklären und ihnen eine Lösung zu bieten.
Liste gesuchter Anleitungen
Hier findest du eine nützliche Liste mit Vorschlägen für neue Anleitungen, die du vielleicht schreiben möchtest. Bestimmte Anleitungthemen und Vorschläge können sogar einen zusätzlichen Belohnungsbonus haben. Du kannst die Liste manuell hier aufrufen.
Denke daran, dass dies nur nützliche Ideen sind, du musst nicht unbedingt darüber schreiben, deine Guide-Vorschläge können wie bereits erwähnt kreativ sein.
Einreichen des Vorschlags
Wenn du dir sicher bist, dass dein Vorschlag für unsere Dokumentation geeignet ist, gehe bitte zu unserem [ZAP Docs GitHub Repository] (https://github.com/zaphosting/docs) und eröffne einen Beitrag mit der Vorlage Beitragsvorschlag. Bitte folge der Vorlage, die dir zur Verfügung gestellt wird, und stelle sicher, dass du alle notwendigen Details ausfüllst. Außerdem musst du bestätigen, dass du unsere Allgemeinen Geschäftsbedingungen für das Beitragsprogramm akzeptierst, die du hier einsehen kannst.
Bitte achte darauf, dass du deine ZAP ID richtig ausfüllst, damit du deine Prämie auf das richtige Konto erhältst!
Nachdem du deinen Vorschlag eingereicht hast, versuchen wir, uns innerhalb von 3-5 Tagen bei dir zu melden. Du erhältst eine Antwort direkt in deinem GitHub-Problem.
**Wenn du Probleme hast, kannst du unserem ZAP-Hosting Discord Server beitreten, wo wir und die ZAP-Community dir gerne bei allen Fragen helfen. Alternativ kannst du uns auch über ein Ticket auf unserer Website kontaktieren und in deiner Nachricht "Contribution Program - Guides" angeben, damit sie an das ZAP-Hosting Contributions Team weitergeleitet wird.
In unserer Antwort geben wir dir zusätzliches Feedback oder Details, die wir bezüglich deines Vorschlags ändern möchten. Wenn es ein Problem gibt, werden wir es direkt in deinem GitHub-Problem ansprechen.
Schritt 2: Schreiben der Anleitung
Wenn du Ergänzungen oder Änderungen an unserer Dokumentation vornimmst, stelle bitte sicher, dass du unsere Beitragsrichtlinien genau befolgst, um Konsistenz und ein hochwertiges Endprodukt zu gewährleisten. In diesem Unterkapitel werden wir uns mit den besten Praktiken und dem optimalen Arbeitsablauf für die Erstellung neuer, aber auch für die Änderung bestehender Inhalte beschäftigen. Wenn du GitHub noch nicht kennst, kannst du die folgenden kurzen Anleitungen nutzen, um zu verstehen, wie du am einfachsten neue Inhalte für unsere ZAP-Docs bearbeiten oder erstellen kannst.
Vergewissere dich, dass du einen Vorschlag auf unserem GitHub Repository erstellt hast und dass dieser von einem Mitglied unseres ZAP Contribution Teams genehmigt wurde, bevor du mit der Arbeit an einer neuen Anleitung oder an Änderungen beginnst. Wir können dir keine Belohnung garantieren, wenn du diesen Prozess nicht befolgt hast, da er nicht genehmigt wurde.
Voraussetzungen:
Der erste Schritt besteht darin, einen eigenen Fork des ZAP-Hosting-Dokumentations-Repository auf GitHub zu erstellen. Dazu gehst du zum ZAP Docs GitHub Repository und drückst den Button Fork oben auf der Seite.
Du solltest das Repository nach dem Vorschlag benennen, der akzeptiert wurde, und den Text "Nur den Master-Zweig kopieren" ankreuzen. Drücke dann auf die Schaltfläche "Erstellen" und warte ein paar Sekunden, bis es erfolgreich geforkt wurde.
Jetzt kannst du zum nächsten Abschnitt gehen, um Inhalte zu erstellen oder zu bearbeiten. Für fortgeschrittene Benutzer kann es sinnvoller sein, die Inhalte lokal zu erstellen, da du sie so einfach und von unterwegs testen kannst.
Methoden zur Erstellung von Anleitungen
Wir empfehlen, Methode 1 zu verwenden, um deine Inhalte zu schreiben, da diese Methode schneller und benutzerfreundlicher ist, besonders für neue Autoren.
- Methode 1: Direkt über die GitHub Website
- Methode 2: Lokal über IDE (git cloning)
Der einfachste und empfohlene Weg, um Inhalte zu erstellen, ist über die GitHub-Website. In diesem Abschnitt zeigen wir dir, wie du über die GitHub-Website eine neue Anleitung erstellst und einen bestehenden Anleitung bearbeitest.
Um zu beginnen, gehe zu der Fork , die du im vorherigen Schritt erstellt hast. Sobald du dich auf deinem ZAP Docs Fork befindest, kannst du über den Ordner docs auf alle Dokumentationsleitfäden zugreifen.
Die Dokumentationsdateien werden nach einer einfachen Konvention benannt, bei der das erste Wort auf die Art der Anleitung verweist, in der Regel auf ein Spiel, ein Produkt oder einen Abschnitt, und alle folgenden Wörter auf den jeweiligen Abschnitt. Zum Beispiel verweist dedicated-windows.md auf den Abschnitt Dedicated Server, speziell für das Betriebssystem Windows.
Jetzt musst du entweder eine bestehende Anleitung öffnen oder eine neue erstellen, wenn du neue Inhalte erstellen willst. Verwende die entsprechende Überschrift unten, um fortzufahren.
- Eine neue Anleitung-Datei erstellen
- Eine bestehende Anleitung-Datei bearbeiten
In diesem Fall gehst du oben rechts in den Ordner "/docs" und drückst auf Datei hinzufügen. Im Menü solltest du auf Neue Datei erstellen klicken, damit sich eine neue Seite öffnet.
Auf dieser Seite kannst du im obersten Verzeichnis einen Namen für deine neue Anleitung festlegen und einfach mit dem Schreiben deines Inhalts beginnen.
Vergiss nicht, als Dateierweiterung .md anzugeben.
In diesem Fall öffnest du die Zieldatei, die du bearbeiten möchtest. In diesem Beispiel nehmen wir dedicated-windows.md. Nachdem du die Datei geöffnet hast, siehst du eine grobe Vorschau, wie sie in Markdown aussieht (das Layout kann aufgrund der Beta-Version leicht abweichen).
Gehe oben rechts in der Datei auf das Bearbeiten-Symbol (Stift). Daraufhin öffnet sich ein Bearbeitungsfenster, in dem du alle Änderungen vornehmen kannst, die du zuvor vorgeschlagen hast und die akzeptiert worden sind.
Weiter: Inhalt erstellen
Jetzt, wo deine Datei fertig ist, kannst du damit fortfahren, den Inhalt zu schreiben, der in deinem Vorschlag vereinbart wurde. Wir empfehlen, regelmäßig zu speichern oder zu bestätigen, um sicherzustellen, dass du nicht möglicherweise etwas von deiner Arbeit verlierst.
Über die Schaltfläche Vorschau oben im Bearbeitungsfenster kannst du in den Vorschaumodus wechseln, der die grobe Vorschau anzeigt, und über die Schaltfläche Bearbeiten wieder zurückschalten.
Bitte beachte, dass einige Docusaurus-spezifische Elemente wie Ermahnungen (Tags wie :::note, :::tip usw.) bei der Vorschau über GitHub möglicherweise nicht korrekt angezeigt werden. Das liegt daran, dass sie nicht Teil des traditionellen Markdowns sind. Sie werden jedoch bei lokalen Tests und in der Produktion korrekt angezeigt.
In den ZAP Guides Guidelines findest du alle Informationen zu Markdown, Struktur, Terminologie und mehr.
Wenn du deine Änderungen vorgenommen hast, klickst du auf die Schaltfläche Änderungen bestätigen..., woraufhin eine Aufforderung erscheint.
Gib eine sinnvolle Commit-Nachricht ein, in der du erklärst, was du getan hast, und ggf. eine ausführliche Beschreibung. Übertrage schließlich die Änderungen. Damit werden die Änderungen in deinen Fork der Dokumente übertragen. Jetzt kannst du im Abschnitt Inhalt einreichen einen Pull Request erstellen, um den Inhalt in unser ZAP-Hosting Docs Repository zu übertragen.
Vielleicht möchtest du Inhalte lieber lokal über eine IDE oder einen Editor wie Visual Studio Code schreiben. In diesem Abschnitt zeigen wir dir, wie du eine neue Anleitung erstellst und einen bestehenden Anleitung lokal mit einem Editor bearbeitest.
Voraussetzungen:
- IDE deiner Wahl, in diesem Beispiel verwenden wir Visual Studio Code
- GitHub Desktop
Der erste Teil des Prozesses besteht darin, dein Fork-Repository zu klonen. Am einfachsten und benutzerfreundlichsten geht das über GitHub Desktop, indem du Hinzufügen auswählst, gefolgt von Repository klonen und dein Fork-Repository auswählst. Du kannst dies auch direkt über die Visual Studio Code-Anwendung tun.
Als nächstes öffnest du den Ordner des Repositorys in Visual Studio Code. Auf der linken Registerkarte Explorer solltest du alle Ordner des Repositorys sehen.
Die Dokumentationsdateien sind nach einer einfachen Konvention benannt: Das erste Wort bezieht sich auf die Art der Anleitung, in der Regel ein Spiel, ein Produkt oder einen Abschnitt, und alle folgenden Wörter beziehen sich auf den jeweiligen Abschnitt. Wir empfehlen dir, auf der aktuellen Website nachzusehen, wo dein vorgeschlagener Anleitung hingehört.
- Eine neue Anleitungsdatei erstellen
- Eine bestehende Anleitungsdatei bearbeiten
In diesem Fall haben wir in unserer Frage vorgeschlagen, dass wir einen neuen Anleitung über das Spiel Rust erstellen wollen, der eine Reihe nützlicher Befehle enthält. Auf der Website können wir sehen, dass es bereits einen Abschnitt Rust unter gameservers gibt. Wir können also im Ordner docs in unserer IDE nachsehen, um die richtige Namenskonvention zu finden. Das bedeutet, dass der Dateiname der Anleitung rust-commands.md lauten wird. Erstelle diese Datei im Ordner docs.
Der nächste Teil besteht darin, die Metadaten der obersten Datei zu platzieren. Am einfachsten geht das, wenn du zu einer anderen Datei gehst, zum Beispiel rust-plugins.md. Kopiere die Top-Metadaten-Tags aus dieser Datei und füge sie in deine neue Datei ein. Bearbeite den Tag id so, dass er mit dem Namen deiner Datei übereinstimmt, in diesem Fall rust-commands, und bearbeite die anderen Metadaten entsprechend dem von dir akzeptierten Vorschlag für den neuen Guide.
Die Datei sollte nun mit (dem Beispiel folgend) beginnen:
---
id: rust-commands
Titel: Admin-Befehle
description: Informationen zu Admin-Befehlen für Rust von ZAP-Hosting - ZAP-Hosting.com Dokumentation
sidebar_label: Admin-Befehle
---
Der letzte Schritt, um sicherzustellen, dass deine neu erstellte Seite in der Seitenleiste angezeigt wird, besteht darin, sie in der Datei sidebar.js an der richtigen Stelle einzufügen. Da der Abschnitt Rust bereits existiert, können wir ihn mit CTRL+F und der Suche nach rust finden. Unter dem letzten Punkt solltest du eine neue Zeile erstellen und den Namen deiner Datei eingeben, in diesem Beispiel ist es rust-commands.
Achte darauf, dass du in der Zeile vor deiner neuen Zeile ein Komma (,) einfügst, damit die Syntax korrekt ist.
Das Bearbeiten einer bestehenden Datei ist sehr einfach, da du nicht die gesamte Dateistruktur einrichten musst.
Öffne einfach die Zieldatei der Anleitung, die du bearbeiten möchtest, im Ordner /docs und schon kannst du fortfahren und alle Änderungen vornehmen, die du zuvor vorgeschlagen hast und die akzeptiert wurden.
Weiter: Inhalt erstellen
Jetzt, wo deine Datei fertig ist, kannst du damit fortfahren, den Inhalt zu schreiben, der in deinem Vorschlag vereinbart wurde. Wir empfehlen, regelmäßig zu speichern oder zu bestätigen, um sicherzustellen, dass du nicht möglicherweise einen Teil deiner Arbeit verlierst.
Du kannst CTRL+SHIFT+V benutzen oder auf das Vorschau-Symbol oben rechts im Editor drücken, um die IDE zu teilen, damit du deine Markdown-Änderungen live sehen kannst.
Bitte beachte, dass einige Docusaurus-spezifische Elemente wie Ermahnungen (Tags wie :::note, :::tip usw.) bei der Vorschau auf GitHub möglicherweise nicht korrekt angezeigt werden. Das liegt daran, dass sie nicht Teil des traditionellen Markdowns sind. Sie werden jedoch bei lokalen Tests und in der Produktion korrekt angezeigt.
Bitte beachte die ZAP Guides Guidelines für alles, was Markdown, Struktur, Terminologie und mehr betrifft.
Wenn du mit den Änderungen an deiner Anleitung fertig bist, musst du als letzten Schritt einen Commit in dein Fork-Repository einfügen und einen Pull Request stellen. Du kannst einen Commit über den GitHub-Desktop erstellen, indem du einen passenden Titel und eine Beschreibung hinzufügst und über den oberen Button einen Push sendest. Du kannst dies auch direkt über Visual Studio Code tun, wenn du das möchtest. Jetzt kannst du im Abschnitt Inhalte einreichen einen Pull Request erstellen, um die Inhalte an unser ZAP-Hosting Docs Repository zu übermitteln.
Wir empfehlen dir, auch den optionalen Abschnitt Lokal testen zu lesen, da du diesen Abschnitt mit dem lokalen Testen koppeln kannst, um einen optimalen Arbeitsablauf zu schaffen, bei dem Änderungen in deinem lokalen Build unterwegs aktualisiert werden, was sich als sehr nützlich erwiesen hat. Dies ist jedoch nicht notwendig.
Optional: Lokales Testen des Builds
Bevor du den endgültigen Pull Request erstellst, ist es in der Regel die beste Praxis, lokal zu bauen und zu testen, um sicherzustellen, dass alles mit den von dir vorgenommenen Änderungen korrekt funktioniert. Wir empfehlen dir, deine Änderungen lokal zu testen, um sicherzustellen, dass dein Pull Request zügig bearbeitet wird. Dies ist jedoch nicht erforderlich und du kannst mit dem nächsten Abschnitt fortfahren, wenn du möchtest.
Dies ist NICHT erforderlich, da wir automatisch einen Build durchführen, wenn du einen Pull Request einreichst. Du kannst dies jedoch zum Debuggen und Testen vor Ort nutzen.
Wenn du die Anleitung befolgt hast, um Änderungen lokal zu erstellen, kannst du den ersten Schritt überspringen, in dem du dein Repository klonst, da du es bereits haben solltest.
Voraussetzungen:
Der erste Teil des Prozesses besteht darin, dein Fork-Repository zu klonen. Am einfachsten und benutzerfreundlichsten geht das über GitHub Desktop, indem du Hinzufügen auswählst, gefolgt von Repository klonen und dein Fork-Repository auswählst.
Du kannst aber auch Git verwenden, um dies zu erreichen. Erstelle einen neuen Ordner, in diesem Fall nehmen wir Docs Test. Gib den Ordner ein und öffne Git Bash (Rechtsklick und Git Bash unter Windows). Gehe zu GitHub und notiere dir die URL deines Forks. Als Nächstes führst du den folgenden Befehl aus und ersetzst dabei [deine_url] durch die URL deines Forks:
git clone [deine_url]
Jetzt solltest du das Repository auf deinen lokalen Rechner geklont haben, egal welche Methode du verwendet hast. Im nächsten Schritt lädst du alle benötigten Module herunter. Gehe einfach zu dem Ordner, den du für dein Repository verwendet hast, klicke mit der rechten Maustaste und öffne ein cmd-Terminal (oder verwende das Git-Fenster). Führe den folgenden Befehl aus, um alle Module herunterzuladen:
npm install
Dieser Vorgang kann einige Zeit dauern, aber sobald er abgeschlossen ist, sollte er einen Ordner "node_modules" in deinem Repository-Ordner erstellen. Wenn du eine Fehlermeldung erhältst, ist es wahrscheinlich, dass du die Node.js-Voraussetzung nicht installiert hast.
Der letzte Schritt besteht darin, die Dokumentationsseite lokal zu starten. Verwende den folgenden Befehl, um die Docs-Website zu erstellen:
npm start
Sobald dies abgeschlossen ist, sollte sich automatisch eine lokale Version der Website in deinem Standardbrowser auf dem Port 3000 öffnen. Diese lokale Version ist genau so, wie die Dokumentation während der Produktion aussehen wird, und hier kannst du alles ausprobieren, was du möchtest!
Wenn du mit deinen Änderungen zufrieden bist, kannst du im nächsten Abschnitt einen Pull Request erstellen, um die Inhalte an das Hauptdokumentations-Repository zu übermitteln.
Schritt 3: Inhalte einreichen
Wenn du deine Beiträge gemacht hast, von denen du glaubst, dass sie unseren Richtlinien genau entsprechen und den höchsten Standards entsprechen, kannst du einen Pull Request erstellen. Dazu gehst du zu deinem Fork des ZAP Docs Repository, drückst auf den Text Beitragen unter den primären Buttons und öffnest einen Pull Request.
Es öffnet sich eine neue Seite, auf der du die Änderungen sehen kannst, die du vorgenommen hast. Standardmäßig enthält die Beschreibung eine kleine Checkliste, um sicherzustellen, dass du alles richtig und umfassend gemacht hast. Du kannst diese Vorlage löschen, sobald du sie durchgeblättert hast, da sie nicht benötigt wird.
Als Nächstes gibst du bitte einen passenden Titel ein, der erklärt, was du gemacht hast. Achte bitte darauf, dass du in der Beschreibung deinen Vorschlag erwähnst und verlinkst, indem du neben der ID des Vorschlags #000 verwendest. Wenn du den Vorschlag nicht über das Menü findest, kannst du schnell zum ZAP Docs GitHub Repository gehen, den Bereich "Issues" aufrufen und dort nach deinem Vorschlag und seiner ID-Nummer suchen.
Sobald du den Titel und die Beschreibung eingegeben und sichergestellt hast, dass die Änderungen korrekt sind, kannst du deinen Pull Request über die Schaltfläche erstellen, um ihn an unser Repository zu senden.
Unser System stellt sicher, dass deine Änderungen eine Reihe von Syntax- und Qualitätsprüfungen bestehen. Wenn beide Prüfungen erfolgreich verlaufen sind, wird dein Pull Request innerhalb weniger Tage vom ZAP-Hosting Docs Team geprüft.
Nach der Prüfung deines Pull Requests bitten wir dich eventuell, einige Änderungen vorzunehmen, die wir für notwendig halten. Es kann auch sein, dass wir selbst einige Änderungen vornehmen, wenn wir es für angemessen halten. Sobald alle zusätzlichen Änderungen abgeschlossen sind, werden wir deine Änderung genehmigen, damit sie veröffentlicht werden kann.
Schritt 4: Anleitungänderungen veröffentlichen & Bezahlung
Sobald wir deinen Pull Request nach Abschluss aller gewünschten Änderungen endgültig akzeptieren, antworten wir auf deinen Pull Request und informieren dich über die wichtigsten Details dazu. Dazu gehören auch Informationen über die Veröffentlichung deiner Änderungen und die Auszahlung deiner Belohnung f ür die erfolgreiche Fertigstellung deiner Änderungen am Anleitung.
Die Belohnung für diese Art von Beitrag hängt von mehreren Faktoren ab, vor allem von der Qualität und dem Umfang des geschriebenen Inhalts sowie von anderen Kriterien, die vom ZAP Contribution Team bewertet werden. Mehr über unsere Kriterien erfährst du in unserem Anleitung für Beitragsbelohnungen.
Herzlichen Glückwunsch zu deinen Beiträgen zu unseren ZAP-Hosting Guides! Wir schätzen alle deine Beiträge! 💚