[WIP] Add Matrix Documentation

config/_default/config.yaml

@@ -6,6 +6,7 @@ theme: learn
 defaultContentLanguage: fr
 defaultContentLanguageInSubdir: true
 
+enableEmoji: true
 removePathAccents: true
 outputs:
   home: ["HTML", "RSS", "JSON"]

content/en/matrix/_index.md

@@ -1,6 +1,5 @@
 ---
 title: "Matrix Documentation"
-date: 2020-08-02T21:26:25+02:00
 chapter: true
 draft: false
 ---
@@ -10,3 +9,14 @@ draft: false
 [Matrix](https://matrix.org) is a free and open, secure, decentralized protocol
 for real-time communication, also known by the name of one of its clients -
 [Element](https://element.io).
+
+## What is Matrix?
+
+{{< youtube jr2mXSKq3B4 >}}
+
+## Why provide Matrix to open science enthusiasts?
+
+## Our long-term goal
+
+In the future, we hope Canada could be connected at least as much as Germany in
+terms of Matrix servers.

content/en/matrix/clients/_index.md

@@ -0,0 +1,72 @@
+---
+title: "Clients / Installation"
+date: 2020-07-02T21:22:27+02:00
+draft: false
+chapter: true
+weight: 15
+---
+
+# Installation of a client / program
+
+To connect to the Matrix federation, you will use a client. The recommended
+client for using Matrix is called Element[^1] and it is free to use. Element is
+the official client developped by the Matrix core team and the only one we
+officially support. It can be used on different systems and devices:
+
+1. **Element Web:**
+   [The browser web application provided by the OSUM team](#web-app)
+1. **Element Desktop:** [Downloads for Linux/Windows/Mac](#desktop-app)
+1. **Element mobile:** [Android/iOS](#mobile-app)
+
+![Element page for client download](get-element.png)
+
+## Element Web {#web-app}
+
+The easiest way is to use Matrix is to open the Element Web application directly
+in your favorite modern browser (for example
+[Mozilla Firefox](https://www.mozilla.org/firefox/)).
+
+Web-App:
+{{% button href="https://chat.openscience.ca" icon="fas fa-globe" %}}chat.openscience.ca{{% /button %}}
+
+Further information can be found in the section ["Element Web
+(Browser)"]({{< ref "matrix/clients/browser" >}} "Element Web (Browser)").
+
+## Element Desktop {#desktop-app}
+
+We recommended that you install Element on your own computer for practicality
+purposes. You will have access to your conversations without having to open a
+browser (however, you will have to update Element from time to time, like any
+other program).
+
+Downloads for:
+{{% button href="https://packages.riot.im/desktop/install/win32/x64/Element%20Setup.exe" icon="fas fa-download" %}}Windows{{% /button %}}
+{{% button href="https://packages.riot.im/desktop/install/macos/Element.dmg" icon="fas fa-download" %}}macOS{{% /button %}}
+{{% button href="/clients/install_linux" icon="fas fa-download" %}}Linux{{% /button %}}
+
+More information can be found in the submenu ["Element
+Desktop"]({{< ref "desktop.md" >}} "Element Desktop").
+
+## Element Mobile {#mobile-app}
+
+To have access to Matrix anywhere you go, you can install the Element Mobile
+client on your smartphone.
+
+<!-- prettier-ignore -->
+Downloads for:
+{{% button href="https://play.google.com/store/apps/details?id=im.vector.app" icon="fas fa-download" %}}Android (Google Play){{% /button %}}
+{{% button href="https://apps.apple.com/app/vector/id1083446067" icon="fas fa-download" %}}iOS (iPhone/iPad){{% /button %}}
+{{% button href="https://f-droid.org/packages/im.vector.app/" icon="fas fa-download" %}}Android (F-Droid){{% /button %}}
+
+Further information can be found in the submenu ["Element
+Mobile"]({{< ref "mobile" >}} "Element Mobile").
+
+## Other clients
+
+If you are familiar with such technologies, you may be tempted to use one of the
+[many clients](https://matrix.org/clients/) developped by the community. Note
+that we will probably not be able to help you if you encounter bugs on other
+clients than Element. Refer to the [Other
+clients]({{% relref "more_clients" %}}) section for more information.
+
+[^1]: Element was formerly known as Riot.im before it became Element.

content/en/matrix/clients/browser.md

@@ -0,0 +1,85 @@
+---
+menutitle: "Element Web (Browser)"
+title: Using our Element Web client
+draft: false
+weight: 10
+---
+
+In order to use our Element Web client, you have to go
+[https://chat.openscience.ca](https://chat.openscience.ca).
+
+{{% notice info %}} The first time you use our service, you will have to
+register by clicking on
+"[Create Account](https://chat.openscience.ca/#/register)" on the chat homepage
+[https://chat.openscience.ca](https://chat.openscience.ca) unless you have
+already registered with another matrix server and know how to join our server
+through the federation.
+
+If you require help during the registration process, refer to the [First
+steps]({{% ref "matrix/first-steps" %}}) section.
+
+{{% /notice %}}
+
+If you are registered, you can skip the registration process section and read
+the [Sign in section below](#sign-in) to make sure to use your existing account
+**on our server** and not create a new account on another server like
+matrix.org.
+
+## Register using the Element Web App
+
+1. Open the Element Web App @ <https://chat.openscience.ca>;
+1. Click on the green _Create Account_ button;
+1. Fill in the form.
+   - Choose your username carefully since it is not possible to change it. We
+     recommend using your `FirstLastname` but you are free to pick any username
+     that complies with our Code of Conduct.
+   - Analogous to e-mail addresses, this results in matrix addresses with the
+     following structure: `@USERNAME:openscience.ca`
+   - E-mail address are mandatory on our server, this is to ensure you can reset
+     your password at anytime.
+1. Click on the _Register_ button.
+1. Voilà, you should now be signed in to the Matrix 🌐!
+
+## Sign in
+
+1. Click on the blue _Sign in_ button.
+1. The default option is to enter your _Username_, but you can change the
+   _Username_ option for the email address you signed up with via the drop-down
+   menu "_Sign in with:_". We recommend leaving it to the default option, namely
+   _Username_.
+1. Enter your username and password
+1. Click on _Sign In_
+1. You are now signed in, congratulations! :tada:
+
+{{% notice warning %}} If you want to immediately start using another [Matrix
+Client]({{< relref "../clients" >}}) instead of the Element Web client installed
+at chat.openscience.ca, it is important to change the home server from the
+default matrix.org server to https://matrix.openscience.ca {{% /notice %}}
+
+## Browser settings
+
+### Browser selection
+
+Recommended are the browsers [Firefox](https://www.mozilla.org/de/firefox/new/),
+[Chromium](https://www.chromium.org/getting-involved/download-chromium), newer
+versions of MS Edge (based on Chromium). Older or unsuitable browsers may only
+show a white page.
+
+### NoScript
+
+Many people use script blockers to protect themselves from
+[Tracking](https://ofaolain.com/blog/2018/04/23/tracker-blocking-with-noscript-and-privacy-badger/)
+and malware in the browser, for example with the addon
+[NoScript](https://addons.mozilla.org/de/firefox/addon/noscript/). Here you have
+to make the following settings (for the integration manager, e.g.
+Jitsi/Etherpad)
+
+<!-- ![Browser plugin settings NoScript with openscience.ca and vector.im selected as trusted script sources](.png) -->
+
+### Cookies
+
+You may also want to allow cookies from the 2 sites below for a smoother
+experience.
+
+- openscience.ca
+- vector.im (for the integration and app manager)

content/en/matrix/clients/desktop.md

@@ -0,0 +1,64 @@
+---
+title: "Element Desktop"
+draft: false
+weight: 20
+---
+
+Downloads for:
+{{% button href="https://packages.riot.im/desktop/install/win32/x64/Element%20Setup.exe" icon="fas fa-download" %}}Windows{{% /button %}}
+{{% button href="https://packages.riot.im/desktop/install/macos/Element.dmg" icon="fas fa-download" %}}macOS{{% /button %}}
+{{% button href="/clients/install_linux" icon="fas fa-download" %}}Linux{{% /button %}}
+
+{{% notice info %}} After installing the Element Desktop client, you will have
+to register if you have not registered yet. As said in the previous sections,
+the first time you use our service, you have to register unless you have already
+registered with another matrix server and know how to join our server through
+the federation.
+
+If you require help during the registration process, refer to the [First
+steps]({{% ref "matrix/first-steps" %}}) section.
+
+{{% /notice %}}
+
+If you are registered, you can skip the registration process section and read
+the [Sign in section below](#sign-in) to make sure to use your existing account
+**on our server** and not create a new account on another server like
+matrix.org.
+
+### Registration process through the Element App
+
+1. Open the Element Desktop App;
+1. Click on the green _Create Account_ button;
+1. Click on **Change** and enter the custom homeserver:
+   `https://matrix.openscience.ca`
+1. Fill in the form. Choose your username carefully since it is not possible to
+   change it. We recommend using your `FirstLastname` but you are free to pick
+   any username that complies with our Code of Conduct.
+   - Analogous to e-mail addresses, this results in matrix addresses with the
+     following structure: `@USERNAME:openscience.ca`
+   - E-mail address are mandatory on our server, this is to ensure you can reset
+     your password at anytime.
+1. Click on the _Register_ button.
+1. Voilà, you should now be signed in to the Matrix 🌐!
+
+### Sign in
+
+1. Click on the blue _Sign in_ button;
+1. To not accidentally end up on the wrong server (matrix.org), click on
+   **Change** and manually specify the home server:
+   `https://matrix.openscience.ca`;
+1. Click Next and enter your credentials. The default option is to enter your
+   _Username_, but you can change the _Username_ option for the email address
+   you signed up with via the drop-down menu "_Sign in with:_". We recommend
+   leaving it to the default option, namely _Username_.
+1. Enter your username and password
+1. Click on _Sign In_
+1. You are now signed in, congratulations! :tada:
+1. By activating the slider under Settings > Settings > "**Automatic start after
+   system login**", the Element client will start after every reboot and you
+   will no longer miss any notifications due to accidentally closing the browser
+   tab.
+
+{{% notice tip %}} There are many useful, additional settings and
+recommendations described in the [Settings]({{% relref "../settings" %}})
+section that will make you life easier :smile: {{% /notice %}}

content/en/matrix/clients/mobile.md

@@ -0,0 +1,60 @@
+---
+title: "Element Mobile"
+draft: false
+chapter: false
+weight: 30
+---
+
+<!-- prettier-ignore -->
+Download the Element app for your platform:
+{{% button href="https://play.google.com/store/apps/details?id=im.vector.app" icon="fas fa-download" %}}Android (Google Play){{% /button %}}
+{{% button href="https://apps.apple.com/app/vector/id1083446067" icon="fas fa-download" %}}iOS (iPhone/iPad){{% /button %}}
+{{% button href="https://f-droid.org/packages/im.vector.app/" icon="fas fa-download" %}}Android (F-Droid){{% /button %}}
+
+{{% notice info %}} After installing the Element Mobile client, you will have to
+register if you have not registered yet. As said in the previous sections, the
+first time you use our service, you have to register unless you have already
+registered with another matrix server and know how to join our server through
+the federation.
+
+If you require help during the registration process, refer to the [First
+steps]({{% ref "matrix/first-steps" %}}) section.
+
+{{% /notice %}}
+
+If you are registered, you can skip the registration process section and read
+the [Sign in section below](#sign-in) to make sure to use your existing account
+**on our server** and not create a new account on another server like
+matrix.org.
+
+## Registration process through the Element Mobile App
+
+1. Open the Element Mobile App;
+1. Click on the green _Create Account_ button;
+1. Click on **Change** and enter the custom homeserver:
+   `https://matrix.openscience.ca`
+1. Fill in the form. Choose your username carefully since it is not possible to
+   change it. We recommend using your `FirstLastname` but you are free to pick
+   any username that complies with our Code of Conduct.
+   - Analogous to e-mail addresses, this results in matrix addresses with the
+     following structure: `@USERNAME:openscience.ca`
+   - E-mail address are mandatory on our server, this is to ensure you can reset
+     your password at anytime.
+1. Click on the _Register_ button.
+1. Voilà, you should now be signed in to the Matrix 🌐!
+
+## Sign in
+
+1. Open the Element Mobile App
+1. Click on _Get Started_
+1. Choose _Other - Custom & advanced settings_
+   - This ensures you do not accidentally end up on the wrong server
+     (matrix.org).
+1. Set the address server to: `https://matrix.openscience.ca` and click on
+   _Continue_.
+1. Enter your credentials. The default option is to enter your _Username_, but
+   you can change the _Username_ option for the email address you signed up with
+   via the drop-down menu "_Sign in with:_". We recommend leaving it to the
+   default option, namely _Username_.
+1. Click on _Sign In_
+1. You are now signed in, congratulations! :tada:

content/en/matrix/clients/more_clients.md

@@ -0,0 +1,16 @@
+---
+title: "Other clients"
+draft: false
+chapter: true
+---
+
+# More clients
+
+For users who like to experiment, there are numerous other clients in addition
+to Element, with which the Matrix communication protocol can be used:
+
+If you want to connect to our server, make sure to use our server:
+`https://matrix.openscience.ca`.
+
+- https://matrix.org/docs/projects/clients-matrix
+- https://matrix.org/docs/projects/try-matrix-now

content/en/matrix/development/_index.md

@@ -0,0 +1,34 @@
+---
+title: "Development"
+draft: false
+chapter: true
+weight: 200
+---
+
+# Further development of Matrix
+
+We, [Open Science UMontreal](https://osumontreal.ca), does not pay for the
+source code but we do pay for the server to host our Matrix instance and put a
+lot of volunteer work into maintaining the server and the documentation.
+
+Matrix is an open standard, which all the details of interoperable communication
+using the matrix set of HTTP-APIs are freely published online. Matrix is also
+open source, which means that the source code of the reference servers, clients
+and services has been released to the public under the Apache v2 license to
+encourage everyone to run their own servers and clients.
+
+![free software banner](/img/free-software-likes-you-and-your-freedom.webp)
+
+Since it is free software, improvement requests can be converted into direct
+programming jobs. Currently still in development, and can be
+promoted/accelerated by orders/donations.
+
+We, the maintainers of this server, are in contact with the Matrix/Element
+developers and try to occasionally contribute to the Matrix ecosystem by means
+of testing, commenting, opening issues, etc. to help with the development of all
+Matrix-related tools.
+
+{{% notice info %}} If you interested in helping with the maintance or develop
+new things, we want to hear from you @ [email protected]. {{% /notice %}}
+
+---