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/
This commit is contained in:
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title="Document"
|
||||
description="Documenter the plugin, or translate the documentation."
|
||||
weight=50
|
||||
chapter=false
|
||||
+++
|
||||
|
||||
{{% notice warning %}}
|
||||
This page is not yet translated in your language, please refer to the english version. You can switch to it by using the language selector in the left menu.
|
||||
{{% /notice %}}
|
@ -0,0 +1,51 @@
|
||||
+++
|
||||
title="Document"
|
||||
description="Documenter the plugin, or translate the documentation."
|
||||
weight=50
|
||||
chapter=false
|
||||
+++
|
||||
|
||||
## General informatiosn
|
||||
|
||||
Always inform the community before working (by creating a new issue, or commenting an existing one). This is to avoid that two persons are
|
||||
working on the same thing, and prevent conflicts.
|
||||
|
||||
Please use the `develop` branch. The `main` branch is reserved to released versions of the plugin, so that the documentation is always synchronized with the released version of the plugin.
|
||||
|
||||
The documentation source code is in the `support/documentation/content` folder.
|
||||
|
||||
The documentation is generated using [Hugo](https://gohugo.io/).
|
||||
You have to install it on your computer if you want to preview your work.
|
||||
|
||||
The used theme is [hugo-theme-learn](https://learn.netlify.app/).
|
||||
You should read its documentation before starting editing the documentation.
|
||||
|
||||
## Translations
|
||||
|
||||
The principal language is english (`en` code).
|
||||
|
||||
The different translations of the same file are side by side in the
|
||||
tree, and are identified by a language code in the file name extension.
|
||||
Example: `_index.fr.md` is the French translation of `_index.en.md`.
|
||||
|
||||
Please note that a missing translation file will not appear in the menus of the generated site.
|
||||
|
||||
**Always make sure to create files for all languages**, even if the translation is not yet available.
|
||||
|
||||
For this, there is a script `doc-generate-missing-translations.sh` in the root of the repository. When you add a new file, you just have to create the english version, then run this script. It will create all missing translations, putting a sample message inviting the user to read the english version.
|
||||
|
||||
## Preview
|
||||
|
||||
To preview your modifications, just run:
|
||||
|
||||
```bash
|
||||
hugo serve -s support/documentation/
|
||||
```
|
||||
|
||||
Then open your browser on the address
|
||||
[http://localhost:1313/peertube-plugin-livechat/](http://localhost:1313/peertube-plugin-livechat/).
|
||||
This page will automatically refresh on each modification.
|
||||
|
||||
## Publication
|
||||
|
||||
Publishing the documentation is automatic, as soon as the changes are merged into the `main' branch.
|
@ -0,0 +1,63 @@
|
||||
+++
|
||||
title="Documenter"
|
||||
description="Documenter le plugin, ou traduire la documentation."
|
||||
weight=50
|
||||
chapter=false
|
||||
+++
|
||||
|
||||
## Généralités
|
||||
|
||||
Toujours vous annoncer avant de commencer à travailler (en créant un ticket ou
|
||||
en commentant un ticket existant). Ceci afin d'éviter que plusieurs personnes
|
||||
travaillent sur la même chose et entrent en conflit.
|
||||
|
||||
Merci d'utiliser la branche `develop`.
|
||||
La branche `main` est réservée aux versions publiées, pour que la documentation
|
||||
affichée reste synchronisée avec la version publiée du plugin.
|
||||
|
||||
Le code source de la documentation se trouve dans le dossier
|
||||
`support/documentation/content` du dépot de code.
|
||||
|
||||
La documentation est générée via l'outils [Hugo](https://gohugo.io/).
|
||||
Celui-ci doit être installé sur votre machine pour pouvoir prévisualiser la
|
||||
documentation.
|
||||
|
||||
Le thème utilisé est [hugo-theme-learn](https://learn.netlify.app/).
|
||||
Il est recommandé d'en lire la documentation avant de commencer.
|
||||
|
||||
## Traductions
|
||||
|
||||
La langue principale est l'anglais (code `en`).
|
||||
|
||||
Les différentes traductions d'un même fichier sont côte-à-côte dans
|
||||
l'arborescence, et sont identifiées par un code langue dans l'extension du
|
||||
nom de fichier. Exemple: `_index.fr.md` est la tranduction française de
|
||||
`_index.en.md`.
|
||||
|
||||
Attention, un fichier de traduction manquant n'apparaitra pas dans les menus
|
||||
du site générés.
|
||||
**On veillera donc toujours à créer les fichiers pour toutes les langues**, même
|
||||
si la traduction n'est pas encore disponible.
|
||||
|
||||
Pour cela, il y a un script `doc-generate-missing-translations.sh` à la racine
|
||||
du dépot. Quand on ajoute un nouveau fichier, il suffit de créer la version
|
||||
anglaise, puis de lancer ce script. Il va créer toutes les traductions
|
||||
manquantes, on y mettant un message type invitant l'utilisateur⋅rice à lire la
|
||||
version anglaise.
|
||||
|
||||
## Prévisualiser
|
||||
|
||||
Pour prévisualiser vos modification, il suffit de lancer:
|
||||
|
||||
```bash
|
||||
hugo serve -s support/documentation/
|
||||
```
|
||||
|
||||
Puis d'ouvrir votre navigateur à l'adresse
|
||||
[http://localhost:1313/peertube-plugin-livechat/](http://localhost:1313/peertube-plugin-livechat/).
|
||||
Cette page se raffraichira automatiquement à chaque modification.
|
||||
|
||||
## Publication
|
||||
|
||||
La publication de la documentation est automatique, dès que les modifications
|
||||
sont fusionnées dans la branche `main`.
|
@ -0,0 +1,10 @@
|
||||
+++
|
||||
title="Document"
|
||||
description="Documenter the plugin, or translate the documentation."
|
||||
weight=50
|
||||
chapter=false
|
||||
+++
|
||||
|
||||
{{% notice warning %}}
|
||||
This page is not yet translated in your language, please refer to the english version. You can switch to it by using the language selector in the left menu.
|
||||
{{% /notice %}}
|
Reference in New Issue
Block a user