New documentation, first draft. WIP.

documentation/admin.fr.md

@@ -0,0 +1 @@
+Cette documentation n'est malheureusement pas encore prête.

documentation/admin.md

@@ -0,0 +1 @@
+TODO: this documentation is not ready for now.

documentation/installation.fr.md

@@ -0,0 +1,19 @@
+# Installation du plugin peertube-plugin-livechat 🇫🇷
+
+🇬🇧 English version [here](./installation.md).
+
+**IMPORTANT :** ce plugin ne fonctionne malheureusement pas (encore) tout seul, il doit se reposer sur des outils externes.
+
+**Avant de mettre à jour vers une nouvelle version majeure, merci de lire les notes de version, et la liste des éventuelles modifications non rétro-compatibles : [CHANGELOG](../CHANGELOG.md).**
+
+Ce plugin peut être utilisé de plusieurs manières différentes :
+
+| Mode | Description | Documentation
+---|---|---
+**Serveur Prosody controllé par Peertube (recommandé)** | Ce plugin peut lancer un processus [Prosody](https://prosody.im) et l'auto-configurer. | [Documentation](./prosody.md). **C'est le mode recommandé**
+**Se connecter à un serveur XMPP existant avec ConverseJS** | Vous pouvez utiliser un serveur Jabber/XMPP externe. Ce serveur doit pouvoir utiliser le protocole BOSH ou Websocket, accepter les connexions anonymes, et accepter la création de salons de discussion. |[Documentation](./conversejs.md)
+** Utiliser un outil de chat externe :** | Vous pouvez utiliser un outils de chat externe, si celui-ci peut être inclu dans une iframe. | [Documentation](./external.md)
+
+Pour les deux premiers modes, la connexion vers le serveur XMPP est faite via la bibliothèque javascript [ConverseJS](https://conversejs.org/).
+
+Il y a de la documentation pour des paramètres communs aux différents modes ici : [common settings documentation](./common.md).

documentation/installation.md

@@ -0,0 +1,20 @@
+# Plugin peertube-plugin-livechat installation guide 🇬🇧
+
+🇫🇷 Version française [ici](./installation.fr.md)
+
+**IMPORTANT:** unfortunately this plugin does not (yet) work by itself, it must rely on external tools.
+
+**Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](../CHANGELOG.md)**.
+
+This plugin can be used in different ways:
+
+| Mode | Description | Documentation
+---|---|---
+**Prosody server controlled by Peertube (recommended):** | This plugin can launch a [Prosody](https://prosody.im) process and auto-configure it | [Documentation](./prosody.md). **This is the recommanded setup, and is almost automatic to setup**
+**Connect to an existing XMPP server with ConverseJS:** | You can use an external Jabber/XMPP server. This server has to provide BOSH or Websocket API, accept anonymous loggin, and accept room creation. | [Documentation](./conversejs.md)
+**Use an external web chat tool:** | You can use any external web chat tool, that can be included in an iframe. | [Documentation](./external.md)
+
+For the two first solutions, the connection to the XMPP server is made with the [converseJS](https://conversejs.org/) Javascript library.
+XMPP is a protocol for chat applications. It is sometime known has Jabber.
+
+There are some documentation for common settings here: [common settings documentation](./common.md).

documentation/tutorials/prosody.md

@@ -1,5 +1,7 @@
 # Tutorial: quick setup for Prosody XMPP server on your Peertube's instance
 
+**IMPORTANT NOTE:** This tutorial is not the best way to use this plugin. If you want to use the recommanded Prosody setup, please refer to [this](../installation.md) and [this](../prosody.md).
+
 ## Abstract
 
 This tutorial is meant to help you configure [Prosody](https://prosody.im)

documentation/user.fr.md

@@ -0,0 +1 @@
+Cette documentation n'est malheureusement pas encore prête.

documentation/user.md

@@ -0,0 +1 @@
+TODO: this documentation is not ready for now.