diff --git a/contributing.de.md b/contributing.de.md index b67b89bb7..183c404c0 100644 --- a/contributing.de.md +++ b/contributing.de.md @@ -2,7 +2,7 @@ Hier findest du wichtige Informationen bezüglich allgemeiner Voraussetzungen wie [Inhalt](#inhalt), [Sprache](#sprache) und [externe Inhalte](#externe-inhalte), bezüglich dem [Review-Verfahren](#review-verfahren), [Credits](#credits) und eine [kurze Anleitung](#tutorial-beitragen---schritt-für-schritt-anleitung), wie du ein Tutorial einreichen kannst. -> Wenn du ein Tutorial einreichen möchtest, solltest du dir auch das [Beispiel-Tutorial](tutorial-template.de.md) und die [Markdown-Vorschau](https://community.hetzner.com/markdown-test-suite/) ansehen! +> Wenn du ein Tutorial einreichen möchtest, solltest du dir auch das [Beispiel-Tutorial](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.de.md) und die [Markdown-Vorschau](https://community.hetzner.com/markdown-test-suite/) ansehen! ## Allgemeine Voraussetzungen @@ -113,11 +113,11 @@ Da du dein Tutorial am besten kennst, wäre es gut, wenn du uns dabei unterstüt Hier ist ein Beispiel von einem Tutorial, das in Englisch und Deutsch geschrieben wurde und Bilder enthält. - ![example-tutorial-files](example-tutorial-files.jpg) + ![example-tutorial-files](https://raw.githubusercontent.com/hetzneronline/community-content/master/example-tutorial-files.jpg) 3. **Beispiel-Tutorial verwenden** - Beachte, dass alle Tutorials auf Englisch verfasst sein müssen. Wenn du zusätzlich eine deutsche Übersetzung bereitstellen willst, kannst du dieses [Beispiel-Tutorial](tutorial-template.de.md) als Vorlage verwenden. Es enthält ein grundlegendes Layout für das Tutorial, einige Beispiele für die Formatierung und eine Reihe von Tipps und Tricks für die Einrichtung. Du kannst den Inhalt der Datei zu deinem Tutorial kopieren und bearbeiten. + Beachte, dass alle Tutorials auf Englisch verfasst sein müssen. Wenn du zusätzlich eine deutsche Übersetzung bereitstellen willst, kannst du dieses [Beispiel-Tutorial](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.de.md) als Vorlage verwenden. Es enthält ein grundlegendes Layout für das Tutorial, einige Beispiele für die Formatierung und eine Reihe von Tipps und Tricks für die Einrichtung. Du kannst den Inhalt der Datei zu deinem Tutorial kopieren und bearbeiten. - Englische Vorlage: @@ -149,7 +149,7 @@ Da du dein Tutorial am besten kennst, wäre es gut, wenn du uns dabei unterstüt ``` Abgesehen vom Titel, sollten alle anderen Header H2 sein. Wenn es zwei oder mehr Unterpunkte gibt, kannst du diese Unterpunkte mit einem H3-Header formatieren. - Für konkrete Beispiele, wie du ein Tutorial formatieren kannst, schaue dir bitte das [Beispiel-Tutorial](tutorial-template.md) an. + Für konkrete Beispiele, wie du ein Tutorial formatieren kannst, schaue dir bitte das [Beispiel-Tutorial](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.de.md) an. Beim Bearbeiten des Beispiel-Tutorials sollten noch folgende Punkte beachtet werden: @@ -207,7 +207,7 @@ Da du dein Tutorial am besten kennst, wäre es gut, wenn du uns dabei unterstüt Mit der [Markdown-Vorschau](https://community.hetzner.com/markdown-test-suite/) kannst du testen, wie das Tutorial aussehen wird, nachdem es veröffentlicht wurde und prüfen, ob es an einer Stelle noch Formatierungsfehler gibt. - Beachte außerdem, dass ganz unten vom Tutorial der [License-Block](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.de.md?plain=1#L96-L125) angegeben werden muss. Ersetze an dieser Stelle `[submitter's name and email address here]` mit deinem eigenen Namen und deiner E-Mail-Adresse. + Beachte außerdem, dass ganz unten vom Tutorial der [License-Block](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.de.md?plain=1#L109-L138) angegeben werden muss. Ersetze an dieser Stelle `[submitter's name and email address here]` mit deinem eigenen Namen und deiner E-Mail-Adresse. 5. **Commit und push** diff --git a/contributing.md b/contributing.md index be5522d7e..847159dc6 100644 --- a/contributing.md +++ b/contributing.md @@ -2,7 +2,7 @@ Below, you can find information about [content](#content), [language](#language), [external references](#external-references), the [review process](#review-process), [credits](#credits), and a [step by step guide](#how-to-contribute-step-by-step) on how to contribute. -> If you want to contribute a tutorial, you should also check out our [tutorial template](tutorial-template.md) and our [Markdown preview](https://community.hetzner.com/markdown-test-suite/)! +> If you want to contribute a tutorial, you should also check out our [tutorial template](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.md) and our [Markdown preview](https://community.hetzner.com/markdown-test-suite/)! ## General Criteria @@ -113,11 +113,11 @@ Since you know your tutorial best, it would be great if you could help us keep y Here is an example of a tutorial that is available in English and German. It also includes some images. - ![example-tutorial-files](example-tutorial-files.jpg) + ![example-tutorial-files](https://raw.githubusercontent.com/hetzneronline/community-content/master/example-tutorial-files.jpg) 3. **Use the template** - To help you get started, we've prepared a [tutorial template](tutorial-template.md) that you can build on. It includes a basic layout for your tutorial, some examples of formatting, and a number of tips and tricks for setting everything up. You can copy the content of this file to your own tutorial and edit it where needed. + To help you get started, we've prepared a [tutorial template](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.md) that you can build on. It includes a basic layout for your tutorial, some examples of formatting, and a number of tips and tricks for setting everything up. You can copy the content of this file to your own tutorial and edit it where needed. > If you already have a file called `01.en.md`, this command will overwrite the content of that file. @@ -144,7 +144,7 @@ Since you know your tutorial best, it would be great if you could help us keep y ``` Apart from the title, all other headers should be H2. If there are two or more smaller steps within a larger step, you can consider making those smaller steps H3. - For specific examples of how to format a tutorial, please take a look at the [tutorial template](tutorial-template.md). + For specific examples of how to format a tutorial, please take a look at the [tutorial template](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.md). When you edit the tutorial template, you should also note the following: @@ -202,7 +202,7 @@ Since you know your tutorial best, it would be great if you could help us keep y You can use our [Markdown preview](https://community.hetzner.com/markdown-test-suite/) to see how your tutorial will look after it was published and to check your text for any formatting mistakes. - Also make sure that your tutorial includes the [license block](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.md?plain=1#L96-L125) at the bottom of the tutorial file. And remember to replace `[submitter's name and email address here]` with your own name and email address. + Also make sure that your tutorial includes the [license block](https://github.com/hetzneronline/community-content/blob/master/tutorial-template.md?plain=1#L108-L137) at the bottom of the tutorial file. And remember to replace `[submitter's name and email address here]` with your own name and email address. 5. **Commit and push your tutorial** @@ -220,7 +220,7 @@ Since you know your tutorial best, it would be great if you could help us keep y Create a new pull request [on GitHub](https://github.com/hetzneronline/community-content). In your pull request, you should include the following statement: - ``` + ```text I have read and understood the Contributor's Certificate of Origin available at the end of https://raw.githubusercontent.com/hetzneronline/community-content/master/tutorial-template.md and I hereby certify that I meet the contribution criteria described in it.