aboutsummaryrefslogtreecommitdiff
path: root/USAGE_GUIDE.en.md
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 /USAGE_GUIDE.en.md
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
Diffstat (limited to 'USAGE_GUIDE.en.md')
-rw-r--r--USAGE_GUIDE.en.md31
1 files changed, 19 insertions, 12 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"