osumontreal / docs.osumontreal.ca

Official documentation for the Open Science Matrix chat and more broadly the Open Science UMontreal community. / Documentation officielle pour le chat Matrix Open Science et plus largement pour la communauté Open Science UMontréal.

Open Science UMontreal Documentation

https://docs.osumontreal.ca

If you plan to contribute to the documentation repository, we encourage you to read our Contributing Guideline to help you get started.

If you just want to run the website locally, simply run the following command:

1. Clone this repository: git clone --recurse-submodules https://github.com/osumontreal/docs.osumontreal.ca.git
2. cd docs.osumontreal.ca
3. Install Hugo
4. Run hugo server -D
5. Open http://localhost:1313/

License

Copyright (c) 2021 - OSUMontreal and contributors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

docs.osumontreal.ca's Issues

Optimize page loading time

Details:

• 34 requests
• 1.45 MB / 603.10 KB transferred
• Finish: 2.57 s

Tasks

• Remove unused scripts and fonts
• Minify CSS, JS and fonts

Documentation Linux à l'UdeM

• Configurer le Wifi (UdeM avec cryptage, eduroam)
• Configurer le VPN (avec message de ne pas utiliser le proxy)

Auto-détecter le thème dark/light

Logo ratio

Les logos FR(500x178) vs EN(409x162) n'ont pas le même ratio, donc la grosseur du logo change dans le coin en haut à gauche lorsqu'on change de langue.

Solution: Avoir deux logos avec le même ratio.

Add more details in the Encryption section

Créer des captures d'écran pour la documentation de Matrix

Tâches

• Créer un nouveau profil dans Firefox
• Créer des comptes matrix -> @bob:openscience.ca et @alice:openscience.ca
• Créer une conversation privée entre les deux comptes et une room publique

Description

Toutes les captures d'écran doivent avoir les mêmes dimensions et être prisent avec les thèmes light et dark ainsi qu'en français et anglais.

Notes additionnelles

Le logiciel maim permet de rapidement prendre des clichés d'une fenêtre dans son intégralité.

[sudo] apt install maim xdotool xclip
maim -i $(xdotool getactivewindow) | xclip -selection clipboard -t image/png

Hide title when chapter: false

For more flexibility, add the option to hide title when chapter: false.

Motivation: the title appears in the left menu bar, so we can't make it long and we would sometimes benefit from having a longer title in the docs, but not in the menu. When chapter: true, the title doesn't show on the page and it works well.

Some heading levels are unreadable

We need to update the styling for the headings and especially for h6. See the screenshot below:

Mettre à jour LICENSE pour OSUMontreal and contributors

Au lieu de Samuel Guay et Danny Colin, mettre OSUMontreal and contributors comme sur tous les autres repos.

Notice type should be mandatory

Lorsqu'on génère notre propre titre de notice, il n'y a aucune couleur différencier le titre du body de la notice. S'il pouvait y avoir un petit contraste, ce sera 🔥.

{{% notice "Nice Looking Title" %}}
Plain shortcode
{{% /notice %}}

Add What is OSUM section in EN

Notes dans un titre pratiquement invisibles.

Lorsqu'on ajoute des footnotes [^1] dans un titre, le chiffre en question ne semble pas s'ajuster en fonction de la taille de l'écriture en question. Voici ce que ce bloc de titres donne présentement:

# Note[^1]
## Note[^1]
### Note[^1]
#### Note[^1]
##### Note[^1]
###### Note[^1]

À noter que les titres # et ### se centrent automatiquement, mais pas les autres.

Enlever la dépendence à JS pour le menu de droit

Fixer le tabbing order dans le menu principal

Multiple paragraphs within a single "notice" don't work

The following markdown code should render as a single notice but does not.

{{% notice info %}} Unless you have already registered with another matrix
server and know how to join our server through the federation, the first time
you use our service, you will have to register by clicking on
"[Create Account](https://chat.openscience.ca/#/register)" on the homepage
[https://chat.openscience.ca](https://chat.openscience.ca).

If you require help during the registration process, you can refer to the [First
steps]({{% ref "matrix/first-steps" %}}) section.

Analogous to e-mail addresses, this results in matrix addresses with the
following structure: `@USERNAME:openscience.ca`

{{% /notice %}}

Notice titles don't get translated

{{% notice warning %}}
Little short code en français svp.
{{% /notice %}}

gives

Documentation Matrix

• English
• Traduction en français

Add more details in the Important Settings section

Migrate docs' theme to [doks](https://github.com/h-enk/doks)

Add ability to customize a notice title

Currently, we can only specify a type for a notice. See also #25.