Zum Hauptinhalt springen

Guides Prozess

Guides Banner

Erfahre auf dieser Seite mehr über den Prozess der Mitwirkung an unserer ZAP-Docs. Der Prozess ist auf dieser Seite in chronologischer Reihenfolge beschrieben, daher empfehlen wir, hier zu beginnen.

Schritt 1: Inhalte vorschlagen

Der erste Teil des Prozesses umfasst die Erstellung eines Vorschlags über unser GitHub-Repository. Du musst uns detaillierte Angaben zu den Änderungen und Verbesserungen machen, die du vorschlägst.

Bitte stellen sicher, dass deine Idee kein Duplikat einer bestehenden Anleitung oder eines Vorschlags ist und dass du fest davon überzeugt bist, dass sie für Anfänger oder fortgeschrittene Benutzer nützlich sein wird. Du kannst bestehende Vorschläge auf der Issues Page einsehen.

Tipp

Wir empfehlen, unsere Richtlinien durchzulesen, um den Inhalt und den Dokumentationsstil zu verstehen, die wir verfolgen.

Nach welchen Themen suchen wir?

In unseren Anleitungen suchen wir nach einer breiten Palette praktischer und qualitativ hochwertiger Anleitungen zu Produkten, Dienstleistungen und Open-Source-Software, die über ZAP-Hosting verfügbar sind oder sich auf eine unserer Dienstleistungen 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 Einleitung erwähnt, müssen alle Inhalte, die wir produzieren, original sein, um die Urheberrechtsgesetze zu erfüllen. Jegliche unerlaubte Verwendung von KI/generativen Tools und/oder anderen Teilen des geistigen Eigentums ist strengstens untersagt. Unsere Anleitungen zielen darauf ab, qualitativ hochwertige Informationen durch eine Reihe von Schritten zu liefern, um sicherzustellen, dass der Leser versteht, was er tut und wie er es tun kann, mit dem Endziel, den Leser zu erziehen und ihm die Lösung zu liefern.

Liste gesuchter Anleitungen

Wir haben unten eine nützliche Liste mit tollen Vorschlägen für neue Anleitungen, die du vielleicht gerne schreiben würdest. Für bestimmte Themen und -Vorschläge zu Anleitungen gibt es sogar einen Extra-Bonus. Du kannst die Liste hier manuell aufrufen.


Hinweis

Denken daran, dass dies nur nützliche Ideen sind, du musst nicht unbedingt darüber schreiben, deine Vorschläge für die Anleitung können wie bereits erwähnt kreativ sein.

Einreichen des Vorschlags

Nachdem du dir nun sicher bist, dass dein Vorschlag für unsere Dokumentation geeignet ist, gehe bitte zu unserem ZAP Docs GitHub Repository und eröffne ein Issue mit der Vorlage Contribution Suggestion. Bitte befolge die mitgelieferte Vorlage und stellesicher, dass du alle notwendigen Details ausfüllst. Du musst außerdem bestätigen, dass du unsere Allgemeinen Geschäftsbedingungen für das Beitragsprogramm akzeptierst, die du unter Beitragsbedingungen nachlesen kannst.

caution

Bitte vergewisser dich, dass du deine ZAP ID korrekt angibst, um sicherzustellen, dass 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 wirst eine Antwort direkt in deinem GitHub-Issue erhalten.

Tipp

Hast du mit Problemen zu kämpfen? Du kannst 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 anpassen möchten. Wenn es ein Problem gibt, werden wir dies direkt in Ihrem GitHub-Problem ansprechen.

Schritt 2: Schreiben der Anleitung

Wenn du Ergänzungen oder Änderungen an unserer Dokumentation vornimmst, stelle bitte sicher, dass du unsere Richtlinien genau befolgst, um Konsistenz und ein hochwertiges Endprodukt zu gewährleisten. In diesem Unterabschnitt werden wir uns eingehend mit Best Practices und dem optimalen Workflow für die Erstellung neuer Inhalte, aber auch für die Änderung bestehender Inhalte befassen. Wenn du GitHub noch nicht kennst, verwende bitte die folgenden kurzen Anleitungen, um zu verstehen, wie du am einfachsten neue Inhalte für unsere ZAP-Docs bearbeiten oder erstellen kannst.

Hinweis

Vergewisser dich, dass du einen Vorschlag in unserem GitHub Repository erstellt hast und dass dieser von einem Mitglied unseres ZAP-Beitragsteams genehmigt wurde, bevor du mit der Arbeit an einer neuen Anleitung oder Änderungen beginnst. Wir können 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-Docs-Repository auf GitHub zu erstellen. Du kannst dies tun, indem du zum ZAP-Docs-GitHub-Repository gehst und auf den Button Fork oben auf der Seite drückst.

Benenne das Repository nach dem Vorschlag, der akzeptiert wurde, und kreuze den Text Copy the master branch only an. Als Nächstes drückst du den "create"-Knopf und wartest ein paar Sekunden, bis das Projektarchiv erfolgreich geforkt wurde.

Nachdem du deinen eigenen Repository Fork fertiggestellt hast, kannst du nun mit dem folgenden Abschnitt fortfahren, um deinen Beitrag zu vervollständigen. Es gibt zwei Hauptmethoden, um Inhalte zu erstellen. Entweder direkt über die GitHub-Website oder durch lokales Klonen des Repositorys. Der Vorteil der ersten Methode ist, dass sie viel benutzerfreundlicher ist, während der Vorteil der lokalen Methode darin besteht, dass du Docusaurus vorher testen kannst, um Änderungen live zu sehen.

Tipp

Für Anfänger oder Personen ohne viel Erfahrung mit Git empfehlen wir Methode 1, um deine Inhalte zu schreiben, da sie benutzerfreundlicher und schneller ist und alles über einen Webbrowser auf der GitHub-Website erledigt wird. Diese Methode ist viel unkomplizierter, da sie keine lokale Einrichtung erfordert.

Methoden zur Erstellung von Anleitungen

Der einfachste und empfohlene Weg, Inhalte zu erstellen, ist die GitHub-Website. In diesem Abschnitt zeigen wir dir, wie du über die GitHub-Website eine neue Anleitung erstellst und einen bestehenden bearbeitest.

Wechsel zunächst zu dem Fork, den du im vorherigen Schritt erstellt hast. Sobald du dich auf deinem ZAP Docs Fork befindest, kannst du über den Ordner docs auf alle Dokumentationsanleitung zugreifen.

Die Dokumentationsdateien sind nach einer einfachen Konvention benannt, wobei sich das erste Wort auf die Art der Anleitung bezieht, in der Regel auf ein Spiel, ein Produkt oder einen Bereich, und alle folgenden Wörter auf den jeweiligen Bereich. Wir empfehlen einen Blick auf unsere aktuelle ZAP-Docs Website, um den richtigen Bereich zu finden, in den eine Anleitung gehört. Ein Beispiel: dedicated-windows.md verweist auf den Bereich Dedicated Server, speziell für das Betriebssystem Windows.

Nun musst du entweder eine bestehende Anleitungsdatei öffnen oder eine neue erstellen, je nachdem, ob dein Beitrag für die Aktualisierung einer Anleitung oder die Erstellung einer neuen Anleitung relevant ist. Verwenden die entsprechende Registerkarte unten, um die entsprechenden Anweisungen zu erhalten, da eine neue Anleitung einige zusätzliche Dateivorbereitungen erfordert.

In diesem Beispiel war unser Vorschlag, eine neue Anleitung für das Spiel Rust zu erstellen, speziell für die Befehle, die das Spiel bietet. Ein Blick auf die ZAP-Docs-Website und/oder das Repository zeigt, dass unter der Produktkategorie Gameserver bereits ein Abschnitt Rust existiert. Anhand der zuvor erwähnten Namenskonvention und der bestehenden Anleitungen können wir ableiten, dass die neue Anleitung rust-commands.md heißen sollte.

Um eine neue Datei zu erstellen, gehe zum GitHub-Repository, öffne den Ordner docs und wähle auf der rechten Seite des Bildschirms Add File. Im Menü sollten Sie auf die Option Neue Datei erstellen klicken, wodurch eine neue Registerkarte geöffnet wird.

Oben auf der Seite im Dateipfadverzeichnis kannst du den Namen der Datei festlegen. Wie wir bereits festgestellt haben, wird dies in unserem Beispiel „rust-commands.md“ sein.

info

Bitte stelle sicher, dass du die Dateierweiterung .md hinzufügst, da alle Anleitungen im Markdown-Format verfasst sind.

Der nächste Teil besteht darin, wichtige Metadaten am Anfang der Datei hinzuzufügen. Der einfachste Weg, dies zu tun, ist, in eine andere Datei wie rust-plugins.md zu gehen und die obersten Metadaten-Tags zu kopieren. Dann kannst du einfach jeden Wert so anpassen, dass er zu deiner neuen Anleitung passt, wobei der wichtigste Wert das Feld id ist, das mit deinem Dateinamen übereinstimmen muss (ohne .md).

In unserem Beispiel sollte die Datei nun Folgendes enthalten:

---
id: rust-commands
title: "Rust: Admin Befehle"
description: Informationen zu Admin-Befehlen für Rust von ZAP-Hosting - ZAP-Hosting.com Dokumentation
sidebar_label: Admin Befehle
services:
- gameserver
---
Hinweis

Wir überprüfen die Metadaten während unseres Überprüfungsprozesses doppelt. Machen dir also keine Sorgen, wenn du damit Probleme hast und mach einfach weiter.

Weiter: Inhalt erstellen

Nachdem du deine Datei vorbereitet und geöffnet hast, kannst du mit dem Schreiben des Inhalts fortfahren, auf den du dich in deinem Vorschlag geeinigt hast. Wir empfehlen dir, regelmäßig zu speichern oder zu übertragen, um sicherzustellen, dass du keinen Teil deiner Arbeit verlierst.

Schütze deine Arbeit

Während du deinen Inhalt schreibst, solltest du sicherstellen, dass du den Inhalt regelmäßig festlegst oder Kopien davon anfertigst, da der Editor auf GitHub keine automatische Speicherfunktion hat, d.h. wenn du einen Browser-Tab schließt oder etwas passiert, kannst du den Fortschritt verlieren.

Wir empfehlen die Verwendung des Markdown-Tools StackEdit, um deine Inhalte zu schreiben, da du damit deinen Fortschritt lokal speichern und sogar mit deinem Laufwerk oder verschiedenen Konten synchronisieren kannst, wenn du das möchtest. Wenn du fertig bist, kannst du den Inhalt einfach kopieren und in die Datei auf der GitHub-Website einfügen und übertragen.

Über den Button Preview am oberen Rand des Bearbeitungsfensters können Sie in den Vorschaumodus wechseln, der die grobe Vorschau anzeigt, und über den Button Edit wieder zurückschalten.

Docusaurus Elemente

Bitte beachte, dass einige Docusaurus-spezifische Elemente wie Admonitions (Tags wie :::note, :::tip usw.) oder Registerkarten bei der Vorschau über GitHub möglicherweise nicht korrekt angezeigt werden. Dies liegt daran, dass sie nicht Teil des traditionellen Markdown sind, sie werden jedoch bei lokalen Tests und in der Produktion korrekt angezeigt.

Befolgen unsere Richtlinien

Bitte lesen dir die Richtlinien für alles durch, was Markdown, Struktur, Terminologie und mehr betrifft.

Wenn du deine Änderungen vorgenommen hast, klicke auf den Button Commit changes..., woraufhin eine Eingabeaufforderung erscheint.

Gebe eine sinnvolle Commit-Nachricht ein, die erklärt, was du getan hast, und gegebenenfalls eine erweiterte Beschreibung. Übertrage schließlich die Änderungen. Damit werden die Änderungen in deinem Fork der Dokumente übertragen. Du kannst nun zum Inhalte einreichen Abschnitt gehen, um einen Pull Request zu erstellen, um die Inhalte an unser Haupt-ZAP-Docs Repository zu übermitteln.

Optional: Lokales Testen des Builds

Bevor du den endgültigen Pull Request erstellst, ist es in der Regel die beste Praxis, lokal zu kompilieren 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.

Tipp

Dies ist NICHT erforderlich, da wir automatisch einen Build durchführen, wenn du einen Pull Request einreichst. Dennoch kannst du dies als nützlich empfinden, um lokal zu debuggen und live zu testen.

Hinweis

Wenn du die Anleitung befolgt hast, um Änderungen lokal zu erstellen, kannst du den ersten Schritt überspringen, der das Klonen deines Repositorys beinhaltet, da du es bereits besitzen solltest.

Voraussetzungen:

Der erste Teil des Prozesses besteht darin, dein Fork-Repository zu klonen. Der einfachste und benutzerfreundlichste Weg, dies zu tun, ist über GitHub Desktop, indem du Hinzufügen wählst, gefolgt von Repository klonen und dein Fork-Repository auswählst.

Du kannst auch Git verwenden, um dies zu erreichen. Erstelle einen neuen Ordner, in diesem Fall verwenden wir Docs Test. Geben den Ordner ein und öffne Git Bash (Rechtsklick und Git Bash unter Windows). Gehe zu GitHub und notiere dir die URL deines Forks. Führen dann den folgenden Befehl aus und ersetzen dabei [[deine_Url] durch die URL deines Forks:

git clone [[deine_url]]

Nun solltest du das Repository auf deinen lokalen Rechner geklont haben, unabhängig davon, welche Methode du verwendet hast. Im nächsten Schritt musst du alle benötigten Module herunterladen. Gehe dazu 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 installieren

Dies kann einige Zeit in Anspruch nehmen, aber sobald es abgeschlossen ist, sollte ein Ordner node_modules in deinem Repository-Ordner erstellt werden. Wenn du irgendwelche Fehler erhältst, ist es wahrscheinlich, dass du die Node.js-Voraussetzung nicht installiert hast.

Der letzte Schritt besteht darin, die Dokumentationsseite lokal auszuführen. Verwende dazu den folgenden Befehl, um die Docs-Website zu erstellen:

npm start

Sobald dies abgeschlossen ist, sollte sich automatisch eine lokale Version der Website in Ihrem 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, wie du möchtest!

Wenn du mit deinen Änderungen zufrieden bist, kannst du im nächsten Abschnitt einen Pull Request erstellen, um den Inhalt an das Hauptdokumentations-Repository zu übermitteln.

Schritt 3: Inhalte einreichen

Sobald du deine notwendigen Beiträge geleistet hast, von denen du glaubst, dass sie unseren Richtlinien genau entsprechen und von höchstem Standard sind, kannst du einen Pull Request erstellen. Du kannst dies tun, indem du zu deinem Fork des ZAP Docs Repository gehst, den Contribute Text unter den primären Buttons drückst und einen Pull Request öffnest.

Es öffnet sich eine neue Seite, auf der du die Änderungen, die du vorgenommen hast, sehen kannst. 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 durchgesehen hast, da sie nicht benötigt wird.

Als Nächstes gebe bitte einen passenden Titel ein, der erklärt, was getan wurde. Stelle bitte sicher, dass du in der Beschreibung deinen Vorschlag erwähnst/verlinkst, indem du #000 neben der ID des Vorschlags verwendest. Wenn du ihn nicht über das Menü finden kannst, kannst du schnell zum ZAP Docs GitHub Repository gehen, den Abschnitt „Issues“ aufrufen und dort nach deinem Vorschlag und der ID-Nummer suchen, die dieser hat.

Sobald du den Titel und die Beschreibung eingegeben und sichergestellt hast, dass die Änderungen korrekt sind, kannst du deinen Pull Request über den Button 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, wird dein Pull Request schließlich innerhalb weniger Tage vom ZAP-Docs-Team geprüft.

Nach der Prüfung deines Pull Requests werden wir dich eventuell bitten, ein paar Änderungen vorzunehmen, die wir für notwendig erachten. Wir können auch selbst einige Änderungen vornehmen, wenn wir dies für angebracht halten. Sobald alle zusätzlichen Änderungen abgeschlossen sind, werden wir deine Änderung genehmigen, so dass sie zur Veröffentlichung bereit ist.

Schritt 4: Anleitungänderungen veröffentlichen & Bezahlung

Sobald wir deinen Pull Request nach Fertigstellung der gewünschten Änderungen akzeptieren, werden wir auf deinen Pull Request antworten und dich über die wichtigsten Details informieren. Dazu gehören auch Informationen über die Veröffentlichung deiner Änderungen an der Anleitung sowie deine Belohnung für die erfolgreiche Fertigstellung deiner Änderungen an der Anleitung.

info

Die Belohnung für diese Art von Beitrag hängt von einer Reihe von Faktoren ab, insbesondere von der Qualität und dem Umfang des geschriebenen Inhalts, sowie von anderen Kriterien, die vom ZAP Contribution Team bewertet werden. Lies mehr über unsere Kriterien in unseren Belohnungen.

Herzlichen Glückwunsch zu deinem Beitrag zu unseren ZAP-Hosting Anleitungen! Wir schätzen alle deine Beiträge! 💚