matty
/
peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
peertube-plugin-livechat/support/documentation/content/contributing/document/_index.de.md

65 lines
2.9 KiB
Markdown
Raw Normal View History

#117 part 1: New documentation website (#151) This commit concerns the first subtask of this issue: https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117 It provide a brand new documentation website, that replace the previous markdown files. The website is auto-generated using CI/CD, and can be found here: https://johnxlivingston.github.io/peertube-plugin-livechat/
2023-02-13 16:58:06 +00:00
+++
Update documentation on main branch.
2023-02-15 13:44:03 +00:00
title="Dokumentation"
description="Dokumentieren Sie das Plugin, oder übersetzen Sie die Dokumentation."
#117 part 1: New documentation website (#151) This commit concerns the first subtask of this issue: https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117 It provide a brand new documentation website, that replace the previous markdown files. The website is auto-generated using CI/CD, and can be found here: https://johnxlivingston.github.io/peertube-plugin-livechat/
2023-02-13 16:58:06 +00:00
weight=50
chapter=false
+++
Update documentation on main branch.
2023-02-15 13:44:03 +00:00
## Allgemeine Informationen
Informieren Sie die Community immer vor der Arbeit (indem Sie ein neues Problem erstellen oder ein bestehendes kommentieren). Damit soll vermieden werden, dass zwei Personen
an der gleichen Sache arbeiten, und Konflikte zu verhindern.
New dev workflow: Contribution now have to be made on the main branch. A new `documentation` branch is created. Github and Gitlab pipelines are now working on this branch. Develop branch is deprecated, as it is no more necessary.
2023-03-07 13:14:19 +00:00
Bitte benutzen Sie den `main`-Zweig.
Update documentation on main branch.
2023-02-15 13:44:03 +00:00
Der Quellcode der Dokumentation befindet sich im Ordner `support/documentation/content`.
Die Dokumentation wird mit [Hugo](https://gohugo.io/) erstellt.
Sie müssen es auf Ihrem Computer installieren, wenn Sie eine Vorschau Ihrer Arbeit sehen wollen.
Das verwendete Thema ist [hugo-theme-learn](https://learn.netlify.app/).
Sie sollten dessen Dokumentation lesen, bevor Sie mit der Bearbeitung der Dokumentation beginnen.
New dev workflow: Contribution now have to be made on the main branch. A new `documentation` branch is created. Github and Gitlab pipelines are now working on this branch. Develop branch is deprecated, as it is no more necessary.
2023-03-07 13:14:19 +00:00
When a new plugin version is released, or when documentation is updated,
plugin maintainers will merge the `main` branch to the `documentation` branche.
This will trigger github and gitlab pipelines, and update published documentation.
Update documentation on main branch.
2023-02-15 13:44:03 +00:00
## Übersätzungen
Die Hauptsprache ist Englisch (Code `en`).
Die verschiedenen Übersetzungen der gleichen Datei stehen nebeneinander im Verzeichnis und sind durch einen Sprachcode in der Dateinamenerweiterung gekennzeichnet.
Beispiel: `_index.fr.md` ist die französische Übersetzung von `_index.en.md`.
Bitte beachten Sie, dass eine fehlende Übersetzungsdatei nicht in den Menüs der generierten Website erscheint.
**Stellen Sie sicher, dass Sie immer alle Dateien für die Sprachen erstellen**, auch wenn die Übersetzung noch nicht verfügbar ist.
Dafür gibt es ein Skript `doc-generate-missing-translations.sh` im Stammverzeichnis des Projektes. Wenn Sie eine neue Datei hinzufügen, müssen Sie nur die englische Version erstellen und dann dieses Skript ausführen. Es erstellt alle fehlenden Übersetzungen und fügt eine Beispielmeldung hinzu, die den Benutzer auffordert, die englische Version zu lesen.
## Eine neue Sprache hinzufügen
Kopieren und ändern Sie den Abschnitt `[Languages.fr]` in der Datei `support/documentation/config.toml`.
Führen Sie dann das Skript `doc-generate-missing-translations.sh` aus.
Es wird alle fehlenden Dateien erstellen.
Dann können Sie sie eine Datei nach der anderen übersetzen.
Wenn die Übersetzungen nicht vollständig sind, macht das nichts, die generierten Dateien zeigen eine Meldung an, die vorschlägt, die Sprache zu ändern.
## Vorschau
Um eine Vorschau Ihrer Änderungen zu sehen, führen Sie einfach diesen Befehl aus:
```bash
hugo serve -s support/documentation/
```
Öffnen Sie dann Ihren Browser und gehen Sie auf die Adresse
[http://localhost:1313/peertube-plugin-livechat/](http://localhost:1313/peertube-plugin-livechat/).
Diese Seite wird bei jeder Änderung automatisch aktualisiert.
## Veröffentlichung
Die Veröffentlichung der Dokumentation erfolgt automatisch, sobald die Änderungen in den `main` Zweig eingefügt wurden.