aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichel Cadennes <michel.cadennes@assemblee-virtuelle.org>2018-11-19 19:21:48 +0100
committerMichel Cadennes <michel.cadennes@assemblee-virtuelle.org>2018-11-19 19:21:48 +0100
commit22b0ab071c0daaea9527c59bc30585902cb29f96 (patch)
tree8523a242afce78104559c9dcb0ab56b104dd7a5d
parent30f6722bcca5fae4b8b6a253b60044e1d38efc0f (diff)
Correction of errors in the documentation:
1) Rooms are not private because anyone who has an account on the Matrix network can access it 2) The issue concerning the phone number is (maybe) not a bug but the effect of a service limitation (however undocumented) 3) Added a clearer mention about the existence of a mobile app version of Riot (quite correct for that matter) and adding the link for download applications. 4) Clarification on the convention for naming default room of each community
-rw-r--r--USAGE_GUIDE.en.md31
-rw-r--r--USAGE_GUIDE.fr.md28
-rw-r--r--USE.fr.md64
3 files changed, 36 insertions, 87 deletions
diff --git a/USAGE_GUIDE.en.md b/USAGE_GUIDE.en.md
index 10fd3ca..00f4775 100644
--- a/USAGE_GUIDE.en.md
+++ b/USAGE_GUIDE.en.md
@@ -1,32 +1,37 @@
# User guide
-> v0.2 (Nov 16, 2018)
+> v0.3 (Nov 19, 2018)
## Introduction
**Matrix** is now used for Virtual Assembly discussions, replacing Slack. A Matrix server is self-hosted on the association server, and responds to the domain name **matrix.virtual-assembly.org**.
-The principle of Matrix is a juxtaposition of "rooms", spread over a *federation of servers*, which are all independent of each other (and not hierarchical). These rooms can be grouped into **communities**<sup>1</sup> (*groups*) which are divided into filters across all Matrix federation. A room can belong to several communities. Each community has at least one room with the same name.
+The principle of Matrix is a juxtaposition of "rooms", spread over a *federation of servers*, which are all independent of each other (and not hierarchical). These rooms can be grouped into **communities**[^1] (*groups*) which are divided into filters across all Matrix federation. A room can belong to several communities. Each community has at least one room. Our convention is to give the community's name to this default room.
For example, there is a **General** community, which currently includes two rooms: *General* and *Reception*.
## Accessing rooms — Tools
-To access the conversations of the Matrix federation (and more specifically in our case of the Virtual Assembly) you can either:
+To access the conversations of the Matrix federation (and especially in our case Virtual Assembly) you have to choose a client software, of which there is a list accessible on this page: [Matrix clients]. For our part, we recommend [Riot] which is available as both desktop application, web application and mobile app. It is currently the most mature application to access Matrix.
-1. Use the web interface at the following address:
-[Virtual Assembly Community]. You will then land on a page presenting the rooms of the **General** community.
-1. Use a client software, of which there is a list accessible on this page: [Matrix clients]. For our part, we recommend [Riot] which is available as both desktop and mobile applications. It is currently the most mature application to access Matrix. As you will see, the web interface itself uses Riot.
+*In the continuation of the document, we will speak only of Riot. Other clients are not documented here yet.*
-In order to access community discussions, you need to have a **Matrix** account, no matter which server you are registered on. However, your user experience could be different depending on your account (see Configuration)
+* If you use the Riot web interface, go to the following address:
+[Virtual Assembly Community]. You will then arrive on a page presenting the salons of the ** General ** community.
+* To download the desktop application, it's here: [Download Riot]
+* If you prefer the mobile app, go to the iOS or Android store
+
+In order to access community discussions, you need to have a **Matrix** account, no matter which server you are registered for. Be careful, however, your user experience may be different depending on your account (see Configuration)
## Creating an account
*The following section is only about Riot. Other clients are not documented here yet.*
-When you want to join a community or access a room, you will be asked to create an account, unless you are not already registered somewhere on the Matrix network.
+When you open your client and want to join a community or access a trade show, you are asked to create an account unless you are already registered somewhere on the Matrix network.
+
+However, having an account on the ** matrix.virtual-assembmly.org ** server will give you more comfort in the use of the lounges, and in the first place will improve the functions of navigation, search and discovery.
-The instance of the Virtual Assembly is not public. You have to be granted by the sysadmin team of the Assembly, so check tha point first: If you were on Slack, or have been in contact with the Assembly for a long time, it is likely that this is the case. Otherwise, contact someone you know in the Assembly, so that this person alerts the sysadmin team to allow access to the Virtual Assembly rooms<sup>3</sup>. You will soon be notified to create an account.
+The first point to check, if you want to create an account on our server, is that the sysadmin team knows you. If you were on Slack, or have been in contact with the Assembly for a long time, it is likely that this is the case. Otherwise, contact someone you know in the Assembly, so that this person alerts the sysadmin team to allow access to the Virtual Assembly rooms[^3]. You will soon be notified to create an account.
Depending on which page you are on, you can see two different messages. The difference between "**Join the community**" and "**Join the room**" is that, in the first case, you will see the community icon in the far left sidebar of the window. You can be part of as many communities as you want and these ones will visually separate the rooms following different domains of interest.
@@ -35,8 +40,8 @@ For the rest, the registration process is the same in both cases.
> **Beware**: on the web interface, you will see a pop-up window; then click on "*select another server*"
To create an account, fill out the form as follows:
-1. Enter your e-mail address <sup>2</sup>, but ...
-1. **... do not fill in the Phone field** (this causes a bug).
+1. Enter your e-mail address [^2], but ...
+1. **... do not fill in the Phone field** (this would cause your account not work properly).
1. Choose a username and a password
1. Before clicking on **Register**:
1. You must choose the server that will host your account ->
@@ -76,7 +81,7 @@ At the bottom left of the window, you will see a toolbar with the following feat
- Add a community (to existing list)
- Riot Home page
-- Start a discussion with someone<sup>4</sup>
+- Start a discussion with someone[^4]
- Display the catalog of rooms (list depending of your home server)
- Create a new room
- Parameters of your personal profile
@@ -111,6 +116,8 @@ At the bottom left of the window, you will see a toolbar with the following feat
[Riot]: <https://riot.im/>
"Riot - recommended Matrix client"
+[Download Riot]: <https://about.riot.im/downloads/>
+"Downloads of Riot applications"
[Reception]: <https://matrix.to/#/!JQkKPpdjWWQjaeABiV:matrix.virtual-assembly.org>
"Reception - our room to chat with visitors"
diff --git a/USAGE_GUIDE.fr.md b/USAGE_GUIDE.fr.md
index 9e594bd..ee86de9 100644
--- a/USAGE_GUIDE.fr.md
+++ b/USAGE_GUIDE.fr.md
@@ -1,32 +1,35 @@
# Guide d'utilisation
-> v0.2 (16 nov 2018)
+> v0.3 (19 nov 2018)
## Introduction
**Matrix** héberge désormais les discussions de la communauté de l'Assemblée Virtuelle, en remplacement de Slack. Un serveur Matrix est auto-hébergé sur le serveur de l'association, et répond au nom de domaine **matrix.virtual-assembly.org**.
-Le principe de Matrix repose sur une juxtaposition de « salons », répartis sur une *fédération de serveurs* et qui sont tous indépendants les uns des autres (et non hiérarchisés). Ces salons peuvent être regroupés au sein de **communautés**<sup>1</sup> (*groupes*) qui agissent comme des filtres sur l'ensemble des salons de la fédération Matrix. Un salon peut appartenir à plusieurs communautés. A chaque communauté correspond au moins un salon qui porte le même nom.
+Le principe de Matrix repose sur une juxtaposition de « salons », répartis sur une *fédération de serveurs* et qui sont tous indépendants les uns des autres (et non hiérarchisés). Ces salons peuvent être regroupés au sein de **communautés**[^1] (*groupes*) qui agissent comme des filtres sur l'ensemble des salons de la fédération Matrix. Un salon peut appartenir à plusieurs communautés. A chaque communauté correspond au moins un salon. Par convention, nous donnons à celui-ci le même nom que la communauté correspondante.
Ainsi existe une communauté **General**, qui comprend à ce jour deux salons : *General* et *Reception*.
## Outils d'accès aux salons
-Pour accéder aux conversations de la fédération Matrix (et plus particulièrement dans notre cas de l'Assemblée Virtuelle) vous pouvez soit :
+Pour accéder aux conversations de la fédération Matrix (et plus particulièrement dans notre cas de l'Assemblée Virtuelle) vous devez choisir un logiciel client, dont il existe une liste accessible sur cette page : [Matrix clients]. Pour notre part, nous recommandons [Riot] qui est disponible à la fois comme application de bureau, application web et application mobile. C'est actuellement l'application la plus mature pour accéder à Matrix.
-1. Utiliser l'interface web à l'adresse suivante :
+*Dans la suite du document, nous parlerons uniquement de Riot. Les autres clients ne sont pas documentés ici pour l'instant.*
+
+* Si vous utilisez l'interface web de Riot, rendez-vous à l'adresse suivante :
[Communauté Assemblée Virtuelle]. Vous arriverez alors sur une page présentant les salons de la communauté **General**.
-1. Utiliser un logiciel client, dont il existe une liste accessible sur cette page : [Matrix clients]. Pour notre part, nous recommandons [Riot] qui est disponible à la fois comme application de bureau et mobile. C'est actuellement l'application la plus mature pour accéder à Matrix. Comme vous le constaterez l'interface web elle-même utilise Riot.
+* Pour télécharger l'application de bureau, c'est ici : [Télécharger Riot]
+* Si vous préféreez l'application mobile, rendez vous sur le store iOS ou Android
Pour pouvoir accéder aux discussions de la communauté, il est nécessaire d'avoir un compte sur **Matrix**, peu importe le serveur sur lequel vous êtes inscrit. Attention, toutefois, votre expérience utilisateur pourrait être différente en fonction de votre compte (cf. Configuration)
## Création de compte
-*Ce qui suit concerne Riot. Les autres clients ne sont pas documentés ici pour l'instant.*
+Lorsque vous ouvrez votre client et que vous voulez rejoindre une communauté ou accéder à un salon, il vous est demandé de créer un compte, à moins que vous ne soyez déjà inscrit quelque part sur le réseau Matrix.
-Lorsque vous voudrez rejoindre une communauté ou accéder à un salon, il vous sera demandé de créer un compte, à moins que vous ne soyez déjà inscrit quelque part sur le réseau Matrix, .
+Toutefois, avoir un compte sur le serveur **matrix.virtual-assembmly.org** vous offira plus de confort dans l'utilisation des salons, et en premier lieu améliorera les fonctions de navigation, de recherche et de découverte.
-L'instance de l'Assemblée Virtuelle n'est pas publique. La première chose à vérifier pour créer un compte, c'est que vous êtes connu de l'équipe sysadmin de l'Assemblée. Si vous étiez sur Slack, ou que vous êtes de puis longtemps au contact de l'Assemblée, il est probable que ce soit le cas. Sinon, adressez-vous à quelqu'un de l'Assemblée que vous connaissez, afin qu'il avertisse l'équipe sysadmin que vous êtes autorisé à avoir accès aux salons de l'Assemblée Virtuelle<sup>2</sup>. Vous recevrez très rapidement une notification pour créer votre compte.
+La première chose à vérifier pour créer un compte sur notre serveur, c'est que vous êtes connu de l'équipe sysadmin de l'Assemblée. Si vous étiez sur Slack, ou que vous êtes de puis longtemps au contact de l'Assemblée, il est probable que ce soit le cas. Sinon, adressez-vous à quelqu'un de l'Assemblée que vous connaissez, afin qu'il avertisse l'équipe sysadmin que vous êtes autorisé à avoir accès aux salons de l'Assemblée Virtuelle[^2]. Vous recevrez très rapidement une notification pour créer votre compte.
Suivant la page sur laquelle vous êtes, vous pouvez voir deux invitations différentes. La différence entre « **Rejoindre la communauté** » et « **Rejoindre le salon** » est que, dans le premier cas, vous verrez apparaître l'icône de la communauté dans la colonne latérale à l'extrême gauche de la fenêtre. Vous pouvez faire partie d'autant de communautés que vous le souhaitez et celles-ci vous sépareront visuellement les salons selon différents domaines d'intérêt.
@@ -35,8 +38,8 @@ Pour le reste, la procédure d'inscription est la même dans les deux cas.
> **Attention** : sur l'interface web, vous verrez apparaître une fenêtre « pop-up » ; cliquez alors sur « *sélectionner un autre serveur* »
Pour créer un compte, remplissez le formulaire ainsi :
-1. Indiquer votre adresse éléctronique<sup>3</sup>, mais...
-1. **... ne remplissez pas le champ Téléphone** (ceci cause un bug).
+1. Indiquer votre adresse éléctronique[^3], mais...
+1. **... ne remplissez pas le champ Téléphone** (ceci empêcherait votre compte de fonctionner correctement).
1. Choisissez un pseudonyme et un mot de passe
1. Avant de cliquer sur **S'inscrire** :
1. Vous devez choisir le serveur qui hébergera votre compte ->
@@ -76,7 +79,7 @@ En bas à gauche de la fenêtre de Riot, vous trouvez une barre d'outils qui vou
- Ajouter une communauté à la liste existante
- Revenir sur la page d'accueil de Riot
-- Entamer une discussion personnelle avec une personne<sup>4</sup>
+- Entamer une discussion personnelle avec une personne[^4]
- Afficher le répertoire des salons
- Créer un nouveau salon
- Paramètres de votre profil personnel
@@ -112,5 +115,8 @@ En bas à gauche de la fenêtre de Riot, vous trouvez une barre d'outils qui vou
[Riot]: <https://riot.im/>
"Riot - recommended Matrix client"
+[Télécharger Riot]: <https://about.riot.im/downloads/>
+"Téléchargement de l'application Riot"
+
[Reception]: <https://matrix.to/#/!JQkKPpdjWWQjaeABiV:matrix.virtual-assembly.org>
"Reception - our room to chat with visitors"
diff --git a/USE.fr.md b/USE.fr.md
deleted file mode 100644
index 3b9097a..0000000
--- a/USE.fr.md
+++ /dev/null
@@ -1,64 +0,0 @@
-# Introduction
-
-Tout le monde peut accéder aux fils de discussions sur : [[domain virtual-assembly.org]].
-
-You can create a personal [[account]] to access the chat service directly.
-Vous pouvez créer un compte personnel pur accéder au service de conversation directement.
-You can access the service indirectly via another Matrix chat service.
-Si vous avez un compte sur un autre serveur Matrix, vous pouvez accéder aux conversations de l'Assemblée Virtuelle indirectement.
-
-## Clients
-
-Il est possible de participer aux conversations de Matrix via olusieurs [Matrix clients]
-
-Nous recommandons [Riot] qui est disponible à la fois comme application de bureau et mobile
-
-Vous pouvez utiliser plusieurs clients en parallèle.
-
-[Matrix clients]: <https://matrix.org/docs/guides/faq.html#usage>
- "Introduction to common Matrix clients"
-
-[Riot]: <https://riot.im/>
- "Riot - recommended Matrix client"
-
-
-## Configuration
-
-Les membres peuvent céer un compte localement sur le serveur [[domain virtual-assembly.org]].
-
-Les invités peuvent se connecter indirectement via un autre réseau Matrix.
-
-Pour créer un compte local avec Riot, vous devez :
-1. Indiquer le nom du serveur (parfois appelé “Home server” ou “Custom server”) : **matrix.virtual-assembly.org**
-1. Laisser le nom du deuxième serveur tel quel : **riot.im**
-1. Demander la création d'un compte
-1. Remplir le formulaire en donnant votre adresse électronique comme preuve de votre appartenance à l'Assemblée Virtuelle (les adresses ont été reprises depuis Slack)
-1. **Ne remplissez pas le champ Téléphone**.
-
-Les invités et les membres peuvent se connecter depuis l'extérieur - i.e. en utilisant un compte créé depuis un autre réseau Matrix - et arrivent alors sur le fil [Reception].
-
-[Reception]: <https://matrix.to/#/!JQkKPpdjWWQjaeABiV:matrix.virtual-assembly.org>
- "Reception - our room to chat with visitors"
-
-
-## Fils
-
-Tous les fils sont énumérés dans une liste publique
-
-Vous pouvez vous abonner à chaque fil selon le sujets qui vous intéressent.
-
-Vous pouvez mentionner quelqu'un dans une conversation en insérant l'annotation "@pseudo_de_la_personne"
-
-Vous pouvez mentionner toutes les personnes inscrites sur le fil avec l'annotation "@room".
-
-Vous pouvez mentionner uun (autre) fil dans une conversation en faisant précéder son nom d'in croisillon "#".
-
-## Communautés
-
-Matrix communities is a way to help limit view on rooms.
-
-In Matrix clients supporting it,
-You join a community either from a link in the topic of corresponding general room,
-or via a listing of all communities.
-
-You can mention a community in chat by writing its name starting with "+".