Zum Hauptinhalt springen

Guides Prozess

Guides Banner

Erfahre auf dieser Seite mehr über den Prozess, wie du zu unseren ZAP-Docs beitragen kannst. Der Ablauf ist hier chronologisch dargestellt, daher empfehlen wir, hier zu starten.

Schritt 1: Inhalte vorschlagen​

Der erste Teil des Prozesses besteht darin, ein Vorschlags-Issue über unser GitHub-Repository zu erstellen. Du musst uns Details zu den Änderungen und Verbesserungen geben, die du vorhast.

Bitte stelle sicher, dass deine Idee kein Duplikat eines bestehenden Guides oder Vorschlags ist und dass du wirklich glaubst, dass sie für Anfänger oder fortgeschrittene Nutzer nützlich sein wird. Bestehende Vorschläge kannst du dir auf der Issues-Seite anschauen.

Tipp

Wir empfehlen, unsere Richtlinien zu lesen, um den Content- und Dokumentationsstil zu verstehen, den wir verfolgen.

Welche Themen suchen wir?​

In unseren Guides suchen wir eine breite Palette an praxisnahen und hochwertigen Anleitungen zu Produkten, Services und Open-Source-Software, die über ZAP-Hosting verfügbar sind oder sich auf unsere Angebote beziehen. Wenn du Ideen oder Inspiration 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.

Wie eingangs erwähnt, muss sämtlicher Content original sein, um Urheberrechtsverletzungen zu vermeiden. Jegliche unautorisierte Nutzung von KI-/generativen Tools und/oder anderen geistigen Eigentumsrechten ist strikt verboten. Unsere Guides sollen hochwertige Infos in Schritt-für-Schritt-Anleitungen bieten, damit der Leser versteht, was er tut und wie, mit dem Ziel, ihn zu bilden und ihm Lösungen zu liefern.

Gesuchte Guides Liste​

Wir haben eine praktische Liste mit tollen Vorschlägen für neue Guides, die dich interessieren könnten. Für manche Themen gibt es sogar einen extra Bonus als Belohnung. Du kannst die Liste hier manuell einsehen.


Hinweis

Beachte, dass dies nur nützliche Ideen sind, du musst nicht strikt nur darüber schreiben, deine Vorschläge können kreativ sein, wie oben erwähnt.

Vorschlag einreichen​

Wenn du sicher bist, dass dein Vorschlag für unsere Dokumentation passt, geh bitte zu unserem ZAP Docs GitHub Repository und öffne ein Issue mit der Vorlage Contribution Suggestion. Folge der Vorlage und fülle alle nötigen Details aus. Du wirst auch gebeten, unsere Teilnahmebedingungen für das Contribution-Programm zu akzeptieren, die du unter Contribution Terms findest.

Vorsicht

Bitte gib deine ZAP ID korrekt an, damit deine Belohnung auf das richtige Konto ausgezahlt wird!

Nachdem du deinen Vorschlag eingereicht hast, bemühen wir uns, dir innerhalb von 3-5 Tagen zu antworten. Die Antwort erfolgt direkt in deinem GitHub-Issue.

Tipp

Probleme? Tritt gerne unserem ZAP-Hosting Discord Server bei, wo wir und die ZAP-Community dir gerne weiterhelfen. Alternativ kannst du uns über ein Ticket auf unserer Website kontaktieren und "Contribution Program - Guides" im Betreff angeben, damit dein Anliegen an das ZAP-Hosting Contributions Team weitergeleitet wird.

In unserer Antwort geben wir dir Feedback oder Details zu Anpassungen, die wir uns bei deinem Vorschlag wünschen. Falls es Probleme gibt, klären wir das direkt in deinem GitHub-Issue.

Schritt 2: Guide schreiben​

Wenn du Änderungen oder Ergänzungen an unserer Dokumentation vornimmst, halte dich bitte strikt an unsere Richtlinien, um Konsistenz und hohe Qualität sicherzustellen. In diesem Abschnitt gehen wir auf Best Practices und den optimalen Workflow für das Erstellen neuer Inhalte und das Ändern bestehender Inhalte ein. Wenn du neu bei GitHub bist, helfen dir die kurzen Tutorials unten, den einfachsten Weg zu verstehen, um Inhalte für unsere ZAP-Docs zu bearbeiten oder neu zu erstellen.

Hinweis

Stelle sicher, dass du vorher einen Vorschlag in unserem GitHub Repository erstellt hast und dieser von einem Mitglied des ZAP Contribution Teams genehmigt wurde, bevor du mit dem Schreiben eines neuen Guides oder Änderungen beginnst. Ohne Genehmigung können wir keine Belohnung garantieren.

Voraussetzungen:

Der erste Schritt ist, deinen eigenen Fork des ZAP-Docs Repositories auf GitHub zu erstellen. Gehe dazu zum ZAP Docs GitHub Repository und klicke oben auf den Fork-Button.

Benenne das Repository passend zu deinem angenommenen Vorschlag und aktiviere die Option Copy the master branch only. Drücke dann auf Erstellen und warte ein paar Sekunden, bis der Fork fertig ist.

Mit deinem eigenen Fork kannst du jetzt im nächsten Abschnitt deinen Beitrag fertigstellen. Es gibt zwei Hauptmethoden, Inhalte zu erstellen: direkt über die GitHub-Webseite oder lokal per Klonen des Repositories. Ersteres ist benutzerfreundlicher, letzteres erlaubt dir, Docusaurus lokal zu testen und Live-Änderungen zu sehen.

Tipp

Für Anfänger oder Git-Neulinge empfehlen wir Methode 1, da sie einfacher, schneller und komplett über den Browser via GitHub läuft. Kein Setup nötig, weniger Stress.

Methoden zum Erstellen von Guides​

Der einfachste und empfohlene Weg, Inhalte zu erstellen, ist über die GitHub-Webseite. Hier zeigen wir dir, wie du einen neuen Guide erstellst oder einen bestehenden Guide bearbeitest.

Gehe zu deinem Fork, den du im vorherigen Schritt erstellt hast. Dort findest du alle Dokumentations-Guides im docs-Ordner.

Die Dateien sind einfach benannt: Das erste Wort steht für die Art des Guides, meist ein Spiel, Produkt oder Bereich, gefolgt von weiteren Wörtern für den spezifischen Abschnitt. Wir empfehlen, auf unserer aktuellen ZAP-Docs Website zu stöbern, um den passenden Bereich für deinen Guide zu finden. Zum Beispiel steht dedicated-windows.md für den Dedicated Server Bereich, speziell Windows OS.

Jetzt musst du entweder eine bestehende Guide-Datei öffnen oder eine neue erstellen, je nachdem, ob du einen Guide aktualisierst oder einen neuen schreibst. Nutze den passenden Tab unten für die Anleitung, da ein neuer Guide etwas mehr Vorbereitung braucht.

In diesem Beispiel wollen wir einen neuen Guide für das Spiel Rust schreiben, speziell zu den Befehlen, die das Spiel bietet. Auf der ZAP-Docs Website und im Repository sehen wir, dass es bereits eine Rust-Sektion unter den Gameserver-Produkten gibt. Nach der Namenskonvention und den bestehenden Guides sollte der neue Guide rust-commands.md heißen.

Um eine neue Datei zu erstellen, gehe ins GitHub Repository, öffne den docs-Ordner und klicke rechts auf Add File. Wähle dann Create new file aus, es öffnet sich ein neuer Tab.

Oben im Pfad kannst du den Dateinamen setzen, in unserem Beispiel rust-commands.md.

Info

Achte darauf, die Dateiendung .md zu verwenden, da alle Guides im Markdown-Format sind.

Als nächstes fügst du wichtige Metadaten am Anfang der Datei ein. Am einfachsten kopierst du die Metadaten aus einer anderen Datei wie rust-plugins.md und passt sie an. Wichtig ist, dass das Feld id genau deinem Dateinamen ohne .md entspricht.

Unser Beispiel sieht so aus:

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

Wir prüfen die Metadaten nochmal während des Reviews, also keine Sorge, wenn du hier Schwierigkeiten hast – mach einfach weiter.

Weiter: Inhalte erstellen​

Jetzt kannst du den vereinbarten Content schreiben. Speichere oder committe regelmäßig, damit du nichts verlierst.

Sicher arbeiten

Der GitHub-Editor speichert nicht automatisch. Wenn du den Tab schließt oder etwas passiert, kannst du Fortschritt verlieren.

Wir empfehlen das Markdown-Tool StackEdit, um lokal zu schreiben und Fortschritte zu speichern oder zu synchronisieren. Danach kannst du den Text einfach in GitHub kopieren und committen.

Mit dem Preview-Button oben im Editor kannst du zwischen Bearbeiten und Vorschau wechseln.

Docusaurus-Elemente

Manche Docusaurus-spezifischen Elemente wie Admonitions (:::note, :::tip etc.) oder Tabs werden in der GitHub-Vorschau nicht korrekt angezeigt, da sie kein Standard-Markdown sind. Lokal und in Produktion funktionieren sie aber einwandfrei.

Folge unseren Richtlinien

Siehe die Richtlinien für alles zu Markdown, Struktur, Terminologie und mehr.

Nach deinen Änderungen klicke auf Commit changes.... Es öffnet sich ein Fenster.

Gib eine aussagekräftige Commit-Nachricht ein und optional eine ausführliche Beschreibung. Dann committe die Änderungen. Sie landen in deinem Fork. Anschließend kannst du zum Abschnitt Inhalte einreichen gehen, um einen Pull Request zu erstellen und deine Änderungen ins Haupt-Repository einzureichen.

Optional: Build lokal testen​

Bevor du den finalen Pull Request erstellst, ist es gute Praxis, lokal zu bauen und zu testen, ob alles funktioniert. Wir empfehlen das, damit dein Pull Request schneller bearbeitet wird. Es ist aber nicht zwingend nötig.

Tipp

Das ist NICHT verpflichtend, da wir automatisch einen Build bei Pull Requests ausführen. Aber lokal testen hilft beim Debuggen und Live-Check.

Hinweis

Wenn du schon lokal arbeitest, kannst du den ersten Schritt mit dem Klonen überspringen, da du das Repository ja schon hast.

Voraussetzungen:

Klonen des Forks: Am einfachsten mit GitHub Desktop über Add > Clone repository und deinen Fork auswählen.

Alternativ mit Git: Erstelle einen neuen Ordner, z.B. Docs Test. Öffne Git Bash darin (Rechtsklick > Git Bash). Kopiere die URL deines Forks von GitHub und führe aus:

git clone [deine_url]

Jetzt hast du das Repo lokal. Wechsle in den Ordner, öffne ein Terminal (cmd oder Git Bash) und installiere alle Module mit:

npm install

Das kann eine Weile dauern. Wenn Fehler kommen, hast du wahrscheinlich Node.js nicht installiert.

Starte die lokale Seite mit:

npm start

Nach dem Start öffnet sich automatisch eine lokale Version der Website im Browser auf Port 3000. So sieht die Doku später aus und du kannst alles testen!

Wenn du zufrieden bist, kannst du den Pull Request erstellen.

Schritt 3: Inhalte einreichen​

Wenn du deine Beiträge fertig hast und sie unseren Richtlinien entsprechen, kannst du einen Pull Request (PR) erstellen. Gehe dazu zu deinem Fork des ZAP Docs Repositories, klicke auf den Text Contribute unter den Hauptbuttons und öffne einen Pull Request.

Es öffnet sich eine Seite, auf der du deine Änderungen sehen kannst. Standardmäßig ist eine Checkliste in der Beschreibung, die du nach Durchsicht löschen kannst.

Gib einen passenden Titel ein, der erklärt, was du gemacht hast. In der Beschreibung verlinke bitte deinen Vorschlag mit #000 und der ID des Issues. Falls du das nicht im Menü findest, kannst du im Haupt-Repository unter Issues nach deiner Vorschlags-ID suchen.

Wenn Titel, Beschreibung und Änderungen passen, klicke auf den Button, um den Pull Request zu erstellen und an unser Repository zu senden.

Unser System prüft Syntax und Qualität. Wenn alles passt, wird dein PR innerhalb weniger Tage vom ZAP-Docs Team geprüft.

Während der Review-Phase können wir dich bitten, Änderungen vorzunehmen oder wir passen selbst etwas an. Nach Abschluss genehmigen wir deinen PR zur Veröffentlichung.

Schritt 4: Guide veröffentlichen & Belohnung​

Wenn wir deinen Pull Request akzeptieren, antworten wir dir im PR mit wichtigen Infos zur Veröffentlichung deines Guides und zur Auszahlung deiner Belohnung für die erfolgreiche Mitarbeit.

Info

Die Belohnung hängt von verschiedenen Faktoren ab, vor allem Qualität und Umfang des geschriebenen Contents sowie weitere Kriterien, die das ZAP Contribution Team bewertet. Mehr dazu findest du in unseren Rewards.

Glückwunsch zum Beitrag zu unseren ZAP-Hosting Guides! Wir schätzen deine Unterstützung sehr! 💚

Cookie-Einstellungen