#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/

support/documentation/content/contributing/_index.de.md

@@ -0,0 +1,10 @@
++++
+title="Beitragen"
+description="Beitragen"
+weight=60
+chapter=false
++++
+
+Interested in contributing? Awesome!
+
+{{% children style="li" depth="3" description="true" %}}

support/documentation/content/contributing/_index.en.md

@@ -0,0 +1,10 @@
++++
+title="Contributing"
+description="Contributing"
+weight=60
+chapter=false
++++
+
+Interested in contributing? Awesome!
+
+{{% children style="li" depth="3" description="true" %}}

support/documentation/content/contributing/_index.fr.md

@@ -0,0 +1,10 @@
++++
+title="Contribuer"
+description="Contribuer"
+weight=60
+chapter=false
++++
+
+Intéressé⋅e pour contribuer ? Super !
+
+{{% children style="li" depth="3" description="true" %}}

support/documentation/content/contributing/_index.ja.md

@@ -0,0 +1,10 @@
++++
+title="コントリビュート"
+description="コントリビュート"
+weight=60
+chapter=false
++++
+
+Interested in contributing? Awesome!
+
+{{% children style="li" depth="3" description="true" %}}

support/documentation/content/contributing/codeofconduct/_index.de.md

@@ -0,0 +1,10 @@
++++
+title="Code of Conduct"
+description="Contributor Covenant Code of Conduct"
+weight=10
+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 %}}

support/documentation/content/contributing/codeofconduct/_index.en.md

@@ -0,0 +1,137 @@
++++
+title="Code of Conduct"
+description="Contributor Covenant Code of Conduct"
+weight=10
+chapter=false
++++
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by mail at
+git.[at].john-livingston.fr.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

support/documentation/content/contributing/codeofconduct/_index.fr.md

@@ -0,0 +1,135 @@
++++
+title="Code de conduite"
+description="Convention de Code de conduite Contributeur⋅rices"
+weight=10
+chapter=false
++++
+
+## Notre engagement
+
+En tant que membres, contributeur·trice·s et dirigeant·e·s, nous nous
+engageons à faire de la participation à notre communauté
+une expérience sans harcèlement, quel que soit l'âge, 
+la taille corporelle, le handicap visible ou invisible, l'appartenance ethnique,
+les caractéristiques sexuelles, l'identité et l'expression de genre, 
+le niveau d'expérience, l'éducation, le statut socio-économique, 
+la nationalité, l'apparence personnelle, la race, la religion, 
+ou l'identité et l'orientation sexuelle.
+
+Nous nous engageons à agir et interagir de manière à contribuer à une communauté 
+ouverte, accueillante, diversifiée, inclusive et saine.
+
+## Nos critères
+
+Exemples de comportements qui contribuent à créer un environnement positif :
+
+* Faire preuve d'empathie et de bienveillance envers les autres
+* Être respectueux des opinions, points de vue et expériences divergents
+* Donner et recevoir avec grâce les critiques constructives
+* Assumer ses responsabilités et s'excuser auprès des personnes affectées par nos erreurs et apprendre de ces expériences
+* Se concentrer sur ce qui est le meilleur non pas uniquement pour nous en tant qu'individu, mais aussi pour l'ensemble de la communauté
+
+Exemples de comportements inacceptables :
+
+* L'utilisation de langage ou d'images sexualisés et d'attentions ou d'avances sexuelles de toute nature
+* Le _trolling_, les commentaires insultants ou désobligeants et les attaques
+  personnelles ou d'ordre politique
+* Le harcèlement en public ou en privé
+* La publication d'informations privées d'autrui, telle qu'une
+  adresse postale ou une adresse électronique, sans leur autorisation explicite
+* Toute autre conduite qui pourrait raisonnablement être considérée comme inappropriée
+  dans un cadre professionnel
+
+## Responsabilités d'application
+
+Les dirigeant·e·s de la communauté sont chargé·e·s de clarifier et de faire respecter nos normes de
+comportements acceptables et prendront des mesures correctives appropriées et équitables en
+réponse à tout comportement qu'ils ou elles jugent inapproprié, menaçant, offensant ou nuisible.
+
+Les dirigeant·e·s de la communauté ont le droit et la responsabilité de supprimer, modifier ou rejeter
+les commentaires, les contributions, le code, les modifications de wikis, les rapports d'incidents ou de bogues et autres contributions qui
+ne sont pas alignés sur ce code de conduite, et communiqueront les raisons des décisions de modération
+le cas échéant.
+
+## Portée d'application
+
+Ce code de conduite s'applique à la fois au sein des espaces du projet ainsi que
+dans les espaces publics lorsqu'un individu représente officiellement le projet ou sa
+communauté. Font parties des exemples de représentation d'un projet ou d'une
+communauté l'utilisation d'une adresse électronique officielle, la publication sur
+les réseaux sociaux à l'aide d'un compte officiel ou le fait d'agir en tant que représentant·e désigné·e
+lors d'un événement en ligne ou hors-ligne.
+
+## Application
+
+Les cas de comportements abusifs, harcelants ou tout autre comportement
+inacceptables peuvent être signalés aux dirigeant·e·s de la communauté responsables de l'application du code de conduite à git.[at].john-livingston.fr.
+Toutes les plaintes seront examinées et feront l'objet d'une enquête rapide et équitable.
+
+Tou·te·s les dirigeant·e·s de la communauté sont tenu·e·s de respecter la vie privée et la sécurité des
+personnes ayant signalé un incident.
+
+## Directives d'application
+
+Les dirigeant·e·s de communauté suivront ces directives d'application sur l'impact communautaire afin de déterminer
+les conséquences de toute action qu'ils jugent contraire au présent code de conduite :
+
+### 1. Correction
+
+**Impact communautaire** : utilisation d'un langage inapproprié ou tout autre comportement jugé
+non professionnel ou indésirable dans la communauté.
+
+**Conséquence** : un avertissement écrit et privé de la part des dirigeant·e·s de la communauté, clarifiant
+la nature du non-respect et expliquant pourquoi
+le comportement était inapproprié. Des excuses publiques peuvent être demandées.
+
+### 2. Avertissement
+
+**Impact communautaire** : un non-respect par un seul incident ou une série d'actions.
+
+**Conséquence** : un avertissement avec des conséquences dû à la poursuite du comportement.
+Aucune interaction avec les personnes concernées, y compris l'interaction non sollicitée avec
+celles et ceux qui sont chargé·e·s de l'application de ce code de conduite, pendant une période déterminée. 
+Cela comprend le fait d'éviter les interactions dans les espaces communautaires ainsi que sur les canaux externes
+comme les médias sociaux. Le non-respect de ces conditions peut entraîner
+un bannissement temporaire ou permanent.
+
+### 3. Bannissement temporaire
+
+**Impact communautaire** : un non-respect grave des normes communautaires, notamment
+un comportement inapproprié soutenu.
+
+**Conséquence** : un bannissement temporaire de toutes formes d'interactions ou de
+communications avec la communauté pendant une période déterminée. Aucune interaction publique ou
+privée avec les personnes concernées, y compris les interactions non sollicitées
+avec celles et ceux qui appliquent ce code de conduite, n'est autorisée pendant cette période.
+Le non-respect de ces conditions peut entraîner un bannissement permanent.
+
+### 4. Bannissement permanent
+
+**Impact communautaire** : démontrer un schéma récurrent de non-respect des normes de la 
+communauté y compris un comportement inapproprié soutenu, le harcèlement d'un individu
+ainsi que l'agression ou le dénigrement de catégories d'individus.
+
+**Conséquence** : un bannissement permanent de toutes formes d'interactions publiques au sein de
+la communauté.
+
+## Attributions
+
+Ce code de conduite est adapté du
+[Contributor Covenant](https://www.contributor-covenant.org), version 2.0,
+disponible à
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Les Directives d'application ont été inspirées par le
+[Code of conduct enforcement ladder][Mozilla CoC] de Mozilla.
+
+Pour obtenir des réponses aux questions courantes sur ce code de conduite, consultez la FAQ à
+[https://www.contributor-covenant.org/faq][FAQ]. Les traductions sont disponibles
+sur [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

support/documentation/content/contributing/codeofconduct/_index.ja.md

@@ -0,0 +1,10 @@
++++
+title="Code of Conduct"
+description="Contributor Covenant Code of Conduct"
+weight=10
+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 %}}

support/documentation/content/contributing/develop/_index.de.md

@@ -0,0 +1,10 @@
++++
+title="Develop"
+description="Develop"
+weight=40
+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 %}}

support/documentation/content/contributing/develop/_index.en.md

@@ -0,0 +1,64 @@
++++
+title="Develop"
+description="Develop"
+weight=40
+chapter=false
++++
+
+Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
+before you start working on it, and inform the community that you begin coding by claiming the issue.
+
+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.
+
+Prerequisite for building this plugin:
+
+- you must have `npm` installed
+- you must have python venv installed (`python3-venv` package on Debian for example)
+
+To clone the repository:
+
+```bash
+# Clone the repository
+git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
+# Checkout the develop branch
+git checkout develop
+# Initialize the submodules. This command must be run again if any submodules' version changes.
+git submodule update --init --recursive
+
+# Install NPM dependencies and build the module for the first time:
+npm install
+
+# Build the plugin after a modification:
+npm run build
+
+# If you have a fork from the repository, add it as remote (example):
+git remote add me git@github.com:MY_GITHUB_ACCOUNT/peertube-plugin-livechat.git
+
+# Create a local branch for you developments, and checkout it (example):
+git checkout my_development # Note: if an issue is associated, use fix_1234 as your branch name (where 1234 is the issue's number)
+# To propose your modifications, push your branch to your repository (example):
+git push --set-upstream me my_development
+# Then go to your github repository with your web browser to propose the Pull Request (see additional instructions below)
+```
+
+Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
+Once you are ready for a code review before merge, submit a Pull Request. In any case, please
+link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
+
+The front-end code is in the `client` folder, the back-end code in `server`. There are some shared code in `shared` folder.
+
+For general instructions (developping plugins, building, installation, ...), please refer to the [Peertube documentation](https://docs.joinpeertube.org/contribute-plugins?id=write-a-plugintheme).
+
+You can build the plugin with extra debug features simply by using:
+
+```bash
+NODE_ENV=dev npm run build
+```
+
+## ESBuild vs Typescript
+
+This plugin uses ESBuild for frontend code generation, as the official `peertube-plugin-quickstart` plugin.
+ESBuild can handle Typescript, but does not check types
+(see [ESBuild documentation](https://esbuild.github.io/content-types/#typescript)).
+That's why we first compile Typescript with the `-noEmit` option, just to check types (`check:client:ts` in package.json file).
+Then, if everything is okay, we run ESBuild to generate the compiled javascript.

support/documentation/content/contributing/develop/_index.fr.md

@@ -0,0 +1,62 @@
++++
+title="Développer"
+description="Développer et proposer des modifications de code"
+weight=40
+chapter=false
++++
+
+Toujours annoncer les fonctionnalités sur lesquelles vous voulez travailler en créant un ticket ou en commentant un ticket existant, avant de commencer à travailler dessus. Et annoncez clairement à la communauté que vous commencez à travailler dessus. 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.
+
+Pré-requis pour compiler le plugin:
+
+- vous devez avoir installé `npm`
+- vous devez avoir installé les venv python (paquet `python3-venv` sous Debian par exemple)
+
+Pour clôner le dépot :
+
+```bash
+# Cloner le dépot
+git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
+# Passer sur la branche develop
+git checkout develop
+# Initialiser les sous-modules. Cette commande est à refaire si jamais la version d'un l'un des sous-module change.
+git submodule update --init --recursive
+
+# Installer les dépendances NPM et compiler le plugin pour la première fois :
+npm install
+
+# Compiler le plugin après une modification :
+npm run build
+
+# Si vous avez un fork du dépot, ajoutez le en remote (exemple) :
+git remote add me git@github.com:MON_COMPTE_GITHUB/peertube-plugin-livechat.git
+
+# Créez une branche locale pour vos développements et placez vous dessus (exemple) :
+git checkout mon_developpement # NB: si un ticket y est associé, utilisé le nom fix_1234 (où 1234 est le numéro du ticket)
+# Pour proposer vos modifications, poussez votre branche sur votre dépot (exemple) :
+git push --set-upstream me mon_developpement
+# Rendez-vous ensuite sur votre dépot github avec votre navigateur web pour proposer la Pull Request (voir les instructions complémentaires ci-dessous)
+```
+
+Quand vous êtes prêt⋅e à montrer votre code pour avoir un retour, soumettez une Pull Request *draft*.
+Quand vous êtes prêt⋅e pour une relecture de code avant merge, soumettez une Pull Request. Dans tous les cas, merci de lier votre Pull Request au ticket concerné en utilisant la syntax de GitHub : «fixes #issue_number».
+
+Le code du front-end est dans le dossier `client`. Le code backend dans `server`. Il y a du code partagé entre les deux dans `shared`.
+
+Pour les instructions génériques concernant le développement de plugins (building, installation, ...), merci de vous référer à la [documentation Peertube](https://docs.joinpeertube.org/contribute-plugins?id=write-a-plugintheme).
+
+Vous pouvez *builder* le plugin avec des infos de debug supplémentaires en utilisant :
+
+```bash
+NODE_ENV=dev npm run build
+```
+
+## ESBuild vs Typescript
+
+Ce plugin utilise ESBuild pour compiler le code front-end, comme le plugin `peertube-plugin-quickstart` officiel.
+ESBuild peut gérer Typescript, mais ne vérifie pas les types
+(voir [la documentation ESBuild](https://esbuild.github.io/content-types/#typescript)).
+C'est pourquoi on compile d'abord Typescript avec l'option `-noEmit`, juste pour vérifier les types (`check:client:ts` dans le fichier package.json).
+Ensuite, si tout est ok, on lance ESBuild pour générer le javascript compilé.

support/documentation/content/contributing/develop/_index.ja.md

@@ -0,0 +1,10 @@
++++
+title="Develop"
+description="Develop"
+weight=40
+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 %}}

support/documentation/content/contributing/document/_index.de.md

@@ -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 %}}

support/documentation/content/contributing/document/_index.en.md

@@ -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.

support/documentation/content/contributing/document/_index.fr.md

@@ -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`.

support/documentation/content/contributing/document/_index.ja.md

@@ -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 %}}

support/documentation/content/contributing/feedback/_index.de.md

@@ -0,0 +1,10 @@
++++
+title="Give your feedback"
+description="Give your feedback"
+weight=30
+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 %}}

support/documentation/content/contributing/feedback/_index.en.md

@@ -0,0 +1,11 @@
++++
+title="Give your feedback"
+description="Give your feedback"
+weight=30
+chapter=false
++++
+
+You don't need to know how to code to start contributing to this plugin! Other
+contributions are very valuable too, among which: you can test the software and
+report bugs, you can give feedback, features that you are
+interested in, user interface, design, ...

support/documentation/content/contributing/feedback/_index.fr.md

@@ -0,0 +1,9 @@
++++
+title="Donnez vos retours"
+description="Donnez vos retours"
+weight=30
+chapter=false
++++
+
+Vous n'avez pas besoin de coder pour commencer à contribuer à ce plugin !
+Les autres formes de contributions sont également précieuses, parmis lesquelles : vous pouvez tester le plugin et remonter les bugs que vous rencontrez, partager vos retours d'expérience, proposer des fonctionnalités qui vous intéressent, remonter vos remarques sur l'interface, le design, etc.

support/documentation/content/contributing/feedback/_index.ja.md

@@ -0,0 +1,10 @@
++++
+title="Give your feedback"
+description="Give your feedback"
+weight=30
+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 %}}

support/documentation/content/contributing/translate/_index.de.md

@@ -0,0 +1,10 @@
++++
+title="Translate"
+description="Translate the plugin"
+weight=20
+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 %}}

support/documentation/content/contributing/translate/_index.en.md

@@ -0,0 +1,21 @@
++++
+title="Translate"
+description="Translate the plugin"
+weight=20
+chapter=false
++++
+
+You can help us to translate this PeerTube plugin by creating or modifying translation files in the `languages` folder.
+
+Please work on the `develop` branch, and do your commits and pull request on this branch.
+
+If the language you are interesting in does not exist yet, create a file `code.json` in the `languages` folder, where `code` is the language code.
+The language code must be the same as the Peertube's langage code (see [Peertube documentation](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/translation.md)).
+Then add the language file in the `package.json` file, under the key `translations`.
+
+Translation strings are set in the language file as follow:
+
+- files are in [JSON format](https://www.json.org)
+- the JSON key is the english string (see existing keys in the [french translation file](languages/fr.json)).
+- the JSON value is the translating string
+- NB: there is no english translation file (this is how translation works for peertube's plugins)

support/documentation/content/contributing/translate/_index.fr.md

@@ -0,0 +1,21 @@
++++
+title="Traduction"
+description="Traduire le plugin"
+weight=20
+chapter=false
++++
+
+Vous pouvez nous aider à traduire ce plugin Peertube en créant ou modifiant des fichiers de traduction dans le dossier `languages`.
+
+Merci de travailler sur la branche `develop`, et de faire vos _pull request_ sur cette branche.
+
+Si la langue dans laquelle vous souhaitez traduire n'existe pas encore, créez un fichier `code.json` dans le dossier `languages`, où `code` est le code langue.
+Le code langue doit être dans le même format que les codes langues de Peertube (voir la [documentation Peertube](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/translation.md)).
+Ensuite, ajoutez le fichier de langue dans le fichier `package.json`, sous la clé `translations`.
+
+Les traductions sont sous la forme suivante dans le fichier de langue :
+
+- les fichiers sont au [format JSON](https://www.json.org)
+- les clés JSON sont le texte en anglais (voir les clés existantes dans [le fichier de traduction français](languages/fr.json), qui fait référence)
+- la valeur JSON est la traduction
+- NB: il n'y a pas de fichier de traduction pour l'anglais (c'est la façon de fonctionner de Peertube)

support/documentation/content/contributing/translate/_index.ja.md

@@ -0,0 +1,10 @@
++++
+title="Translate"
+description="Translate the plugin"
+weight=20
+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 %}}