From ad8fbf5f042508cd83587f4b934f28c2e339f193 Mon Sep 17 00:00:00 2001 From: Fabric Bot <159731069+FabricMCBot@users.noreply.github.com> Date: Sat, 19 Oct 2024 22:30:41 +0100 Subject: [PATCH] New translations contributing.md (German) --- translated/de_de/contributing.md | 71 ++++++++++++++++++-------------- 1 file changed, 41 insertions(+), 30 deletions(-) diff --git a/translated/de_de/contributing.md b/translated/de_de/contributing.md index 95e614690..43f95c9db 100644 --- a/translated/de_de/contributing.md +++ b/translated/de_de/contributing.md @@ -3,7 +3,7 @@ title: Beitragsrichtlinen description: Richtlinien zur Beitragserstellung für die Fabric-Dokumentation --- -# [Wie man beiträgt](#how-to-contribute) +# Wie man beiträgt {#contributing} Diese Website nutzt [VitePress](https://vitepress.dev/) um statisches HTML von den verschiedenen Markdown-Dateien zu generrieren. Du solltest dich mit den Markdown-Erweiterungen vertraut machen, die VitePress [hier](https://vitepress.dev/guide/markdown#features) unterstützt. @@ -15,21 +15,25 @@ Du hast drei Möglichkeiten, zu dieser Website beizutragen: Alle Beiträge müssen unseren [Stilrichtlinien](#stilrichtlinien) entsprechen. -## Übersetzen der Dokumentation +## Übersetzen der Dokumentation {#translating-documentation} Falls du die Dokumentation in deine Sprache übersetzen möchtest, kannst du dies auf der [Fabric Crowdin-Seite](https://crowdin.com/project/fabricmc) tun. -## Inhalte beitragen + + +## new-content Inhalt beitragen {#contributing-content} Inhaltliche Beiträge sind die wichtigste Möglichkeit, zur Fabric-Dokumentation beizutragen. -Alle inhaltlichen Beiträge durchlaufen drei Stufen: +Alle Inhaltsbeiträge durchlaufen die folgenden Stufen, die jeweils mit einem Label versehen sind: -1. Anleitung für Erweiterung (falls möglich) -2. Überprüfung des Inhalts -3. Bereinigung (Grammatik etc.) +1. locally Änderungen vorbereiten und einen Pull Request pushen +2. stage:expansion: Anleitung zur Erweiterung, falls erforderlich +3. stage:verification: Verifikation des Inhalts +4. stage:cleanup: Grammatik, Linting... +5. stage:ready: Bereit zum mergen! -Alle Inhalte sollten unseren Stilrichtlinien entsprechen. +Alle Inhalte sollten unseren [Stilrichtlinien](#style-guidelines) entsprechen. ### 1. Deine Änderungen vorbereiten {#1-prepare-your-changes} @@ -44,7 +48,7 @@ Du kannst [hier](https://docs.github.com/en/get-started/using-github/github-flow Du kannst entweder Änderungen über die Weboberfläche auf GitHub vornehmen oder die Website lokal entwickeln und in der Vorschau anzeigen. -#### lokal Den Fork klonen {#clone-your-fork} +#### Deinen Fork klonen {#clone-your-fork} Wenn du lokal entwickeln willst, musst du [Git](https://git-scm.com/) installieren. @@ -55,7 +59,7 @@ Danach klone deinen Fork des Repository mit: git clone https://github.com/your-username/fabric-docs.git ``` -#### lokal Abhängigkeiten installieren {#install-dependencies} +#### Abhängigkeiten installieren {#install-dependencies} **Wenn du deine Änderungen lokal ansehen möchtest, musst du [Node.js 18+](https://nodejs.org/en/) installieren.** @@ -65,7 +69,7 @@ Danach stelle sicher, dass du alle Abhängigkeiten installierst: npm install ``` -#### lokal Den Entwicklungsserver ausführen {#run-the-development-server} +#### Den Developmentserver ausführen {#run-the-development-server} Damit kannst du deine Änderungen lokal auf `localhost:3000` ansehen und die Seite wird automatisch neu geladen, wenn du Änderungen vornimmst. @@ -75,7 +79,7 @@ npm run dev Jetzt kannst du die Website über den Browser öffnen und durchsuchen, indem du `http://localhost:5173` aufrufst. -#### lokal Bauen der Website {#building-the-website} +#### Die Website bauen {#building-the-website} Dies wird alle Markdown-Dateien in statische HTML-Dateien kompilieren und diese in `.vitepress/dist` ablegen @@ -83,7 +87,7 @@ Dies wird alle Markdown-Dateien in statische HTML-Dateien kompilieren und diese npm run build ``` -#### lokal Vorschau der gebauten Website {#previewing-the-built-website} +#### Vorschau der gebauten Website {#previewing-the-built-website} Dies wird einen lokalen Server auf Port 3000 starten, der den Inhalt in `.vitepress/dist` bereitstellt. @@ -91,7 +95,7 @@ Dies wird einen lokalen Server auf Port 3000 starten, der den Inhalt in `.vitepr npm run preview ``` -#### lokal Öffnen eines Pull Requests {#opening-a-pull-request} +#### Einen Pull Request öffnen {#opening-a-pull-request} Wenn du mit deinen Änderungen zufrieden bist, kannst du sie \`push´en: @@ -103,25 +107,34 @@ git push Folge dann dem Link in der Ausgabe von `git push`, um einen PR zu öffnen. -### 2. [Anleitung zur Erweiterung](#guidance-for-expansion) +### 2. stage:expansion Anleitung zur Erweiterung, falls erforderlich {#2-guidance-for-expansion-if-needed} + +Wenn das Dokumentationsteam der Meinung ist, dass du deinen Pull Request erweitern könntest, wird ein Mitglied des Teams das Label stage:expansion zu deinem Pull Request hinzufügen, zusammen mit einem Kommentar, der erklärt, was du deren Meinung nach erweitern könnten. Wenn du mit dem Vorschlag einverstanden bist, kannst du deinen Pull-Request erweitern. -Wenn das Dokumentationsteam der Meinung ist, dass du deinen Pull Request erweitern könntest, wird ein Mitglied des Teams den Vermerk `can-expand` zu deinem Pull Request hinzufügen, zusammen mit einem Kommentar, der erklärt, was du ihrer Meinung nach erweitern könntest. Wenn du mit dem Vorschlag einverstanden bist, kannst du deinen Pull-Request erweitern. +Wenn du deinen Pull Request nicht erweitern willst, aber gerne möchtest, dass jemand anderes ihn zu einem späteren Zeitpunkt erweitert, solltest du ein Issue auf der [Issues Seite](https://github.com/FabricMC/fabric-docs/issues) erstellen und erklären, was deiner Meinung nach erweitert werden könnte. Das Dokumentationsteam fügt dann das Label help-wanted zu deinem PR hinzu. -Fühle dich nicht unter Druck gesetzt, deinen Pull Request zu erweitern. **Fühl dich nicht unter Druck gesetzt, deine Anfrage zu erweitern** Wenn du deine Anfrage nicht erweitern möchtest, kannst du einfach darum bitten, dass die Kennzeichnung `can-expand` entfernt wird. +### 3. stage:verification Verifikation des Inhalts {#3-content-verification} -Wenn du deinen Pull-Request nicht erweitern willst, aber gerne möchtest, dass jemand anderes ihn zu einem späteren Zeitpunkt erweitert, ist es am besten, ein Issue auf der [Issues-Seite](https://github.com/FabricMC/fabric-docs/issues) zu erstellen und zu erklären, was deiner Meinung nach erweitert werden könnte. +Dies ist die wichtigste Phase, da sie sicherstellt, dass der Inhalt korrekt ist und den Stilrichtlinien der Fabric Documentation entspricht. -### 3. [Überprüfung des Inhalts](#content-verification) +In dieser Phase sollten die folgenden Fragen beantwortet werden: -Dies ist die wichtigste Phase, da sie sicherstellt, dass der Inhalt korrekt ist und den Fabric Stilrichtlinien der Dokumentation entspricht. +- Ist der ganze Inhalt korrekt? +- Ist der ganze Inhalt aktuell? +- Deckt der Inhalt alle Fälle ab, z. B. verschiedene Betriebssysteme? -### 4. [Aufräumen](#cleanup) +### 4. stage:cleanup Aufräumen {#4-cleanup} -In dieser Phase behebt das Dokumentationsteam Grammatikfehler und nimmt andere Änderungen vor, die es für notwendig hält, bevor es den Pull-Request mergt! +In dieser Phase passiert folgendes: -## Zum Framework beitragen +- Beheben aller Grammatikfehler mit [LanguageTool](https://languagetool.org/) +- Linten alle Markdown-Dateien mit [`markdownlint`](https://github.com/DavidAnson/markdownlint) +- Formatierung des ganzen Java-Code mit [Checkstyle](https://checkstyle.sourceforge.io/) +- Andere verschiedene Korrekturen oder Verbesserungen -Alle Pull-Requests, die das Framework der Website verändern, sollten mit dem Label `framework` gekennzeichnet werden. +## framework Zum Framework beitragen {#contributing-framework} + +Framework bezieht sich auf die interne Struktur der Website. Alle Pull Requests, die das Framework der Website verändern, werden mit dem Label framework gekennzeichnet. Du solltest wirklich nur Pull-Requests für das Framework eröffnen, nachdem du dich mit dem Dokumentationsteam im [Fabric Discord](https://discord.gg/v6v4pMv) oder über ein Issue beraten hast. @@ -129,7 +142,7 @@ Du solltest wirklich nur Pull-Requests für das Framework eröffnen, nachdem du **Hinweis: Das Ändern von Seitenleistendateien und der Konfiguration der Navigationsleiste zählt nicht als Pull-Request für das Framework.** ::: -## [Stilrichtlinien](#style-guidelines) +## Stilrichtlinien {#style-guidelines} Wenn du unsicher bist, kannst du im [Fabric Discord](https://discord.gg/v6v4pMv) oder über GitHub Diskussionen nachfragen. @@ -137,8 +150,6 @@ Wenn du unsicher bist, kannst du im [Fabric Discord](https://discord.gg/v6v4pMv) Die ganze originale Dokumentation ist in englischer Sprache verfasst und folgt den amerikanischen Grammatikregeln. -Du kannst zwar [LanguageTool](https://languagetool.org/) verwenden, um deine Grammatik während der Eingabe zu überprüfen, aber mache dir nicht zu viele Gedanken darüber. Unser Dokumentationsteam überprüft und korrigiert die Grammatik während der Bereinigungsphase. Wenn man sich jedoch von Anfang an bemüht, es richtig zu machen, können wir Zeit sparen. - ### Daten zum Frontmatter hinzufügen {#add-data-to-the-frontmatter} Alle Seiten müssen einen Titel und eine Beschreibung im Frontmatter haben. @@ -180,7 +191,7 @@ Dies wird die Zeilen 15-21 der Datei `FabricDocsReference.java` des Referenz-Mod <<< @/reference/latest/src/main/java/com/example/docs/FabricDocsReference.java{15-21} ``` -[Richtlinien zur Beitragserstellung für die Fabric-Dokumentation](#fabric-documentation-contribution-guidelines) +<<< @/reference/latest/src/main/java/com/example/docs/FabricDocsReference.java{15-21}[java] ::: @@ -204,7 +215,7 @@ Wenn du einen neuen Abschnitt erstellst, solltest du eine neue Seitenleiste im O Wenn du dabei Hilfe benötigst, frage bitte auf dem [Fabric Discord](https://discord.gg/v6v4pMv) im Kanal `#docs` nach. -### Anleitung zur Erweiterung +### Anleitung zur Erweiterung {#add-new-pages-to-the-relevant-sidebars} Wenn du eine neue Seite erstellst, solltest du sie der entsprechenden Seitenleiste im Ordner `.vitepress/sidebars` hinzufügen. @@ -214,7 +225,7 @@ Auch hier gilt: Wenn du Hilfe benötigst, frage auf dem Fabric Discord im Kanal Alle Bilder sollten an einem geeigneten Ort im Ordner `/assets` abgelegt werden. -### Nutze relative Links! ⚠️ **Wenn du andere Seiten verlinkst, verwende relative Links.** ⚠️ +### Nutze relative Links! {#use-relative-links} Der Grund dafür ist das vorhandene Versionssystem, das die Links verarbeitet, um die Version vorher hinzuzufügen. Wenn du absolute Links verwendest, wird die Versionsnummer nicht zum Link hinzugefügt.