From 4b584b2eb3b17c09d6ccd55c9ef878bf0c5d9703 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Fri, 1 Mar 2024 04:59:04 +0100 Subject: [PATCH] help page improvements --- pages/07.help/help.fr.md | 37 ++++++++++++++++++++++++------------- pages/07.help/help.md | 26 +++++++++++++++++++------- 2 files changed, 43 insertions(+), 20 deletions(-) diff --git a/pages/07.help/help.fr.md b/pages/07.help/help.fr.md index 8d04c66c..850263f8 100644 --- a/pages/07.help/help.fr.md +++ b/pages/07.help/help.fr.md @@ -7,31 +7,38 @@ routes: default: '/help-me' --- -Bien que les contributeurs de YunoHost essaient continuellement de l'améliorer, YunoHost ou sa documentation ne sont exempts de bugs ou d'erreurs. Pour nous aider à vous aider, vous devez cependant suivre ces instructions. +Bien que les personnes contribuant à YunoHost essaient continuellement de l'améliorer, YunoHost ou sa documentation ne sont exempts de bugs ou d'erreurs. Pour nous aider à vous aider, vous devez cependant suivre ces instructions. -Le support n'est prodigué que sur [le forum](https://forum.yunohost.org?target=_blank) ou sur [nos salons de discussion](/chat_rooms?target=_blank). -Nous sommes présents sur Mastodon, mais nous ne prodiguons pas d'aide sur cette plateforme. +Le support n'est prodigué que sur [le forum](https://forum.yunohost.org?target=_blank) ou sur [nos salons de discussion](/chat_rooms?target=_blank). +Nous avons un compte Mastodon, mais nous ne prodiguons pas d'aide sur cette plateforme. -Pour que nous puissions être en mesure de vous aider sur le forum, vous devez impérativement remplir le modèle de demande de support. +Pour que nous puissions être en mesure de vous aider sur le forum, vous devez impérativement remplir le modèle de demande de support qui s'affichera lors de la création du message. -# À faire +# À faire -## Soyez courtois et patient +## Patience et courtoisie -L'aide dans les salons de discussion ou sur le forum est apportée par nos utilisateurs et contributeurs, tous bénévoles. Que vous soyiez peut-être pressé, ou épuisé par des essais infructueux... Faites une pause, buvez une gorgée de votre boisson apaisante préférée, puis poursuivez votre lecture. Nous avons besoin de vous dans un bon état d'esprit pour vous aider. +L'aide dans les salons de discussion ou sur le forum est apportée par des personnes entièrement bénévoles. Peut-être que vous-vous sentez sous pression, épuisé·e par des essais infructueux ou encore submergé·e par de mauvaises émotions... Faites une pause, buvez une gorgée de votre boisson apaisante préférée, soufflez, et une fois votre contenance revenue, poursuivez votre lecture. Nous avons besoin de vous dans un bon état d'esprit pour vous aider. ## Expliquez le contexte -Votre demande doit être formulée de manière complète mais concise. Expliquez clairement ce que vous voulez obtenir et en quoi cela ne fonctionne pas pour vous. + +Votre demande doit être formulée de manière complète mais concise. Expliquez clairement ce que vous voulez obtenir et en quoi cela ne fonctionne pas pour vous. +N'hésitez pas à fournir toute information qui peut être pertinente, même des choses qui peuvent sembler être une évidence, la ou les personnes qui vont essayer de vous aider auront peut-être besoin de ces informations. ## Montrez les erreurs et les journaux + Ceci est absolument primordial si YunoHost ou une commande échoue. YunoHost explique toujours pourquoi, que ce soit par un simple code d'erreur ou par un pavé de texte apparemment incompréhensible. YunoHost fournit des boutons verts "Partager avec YunoPaste" lorsque quelque chose échoue ou dans la page Services de la webadmin. Cliquez dessus, ce qui ouvrira une nouvelle page web dont vous pourrez partager l'URL. -![YunoPaste button](image://yunopaste.png) +Il est recommandé de partager ces logs dans leur intégralité à l'aide du lien généré par YunoPaste. +Évitez les extraits de logs, une information déterminante est peut-être ailleurs. +Évitez aussi de les copier-coller de manière brutte dans le forum, car c'est désagréable de les parcourir comme ça, partagez le lien de YunoPaste. -![YunoPaste from install error](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted) -![YunoPaste from service](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted) +![Bouton YunoPaste](image://yunopaste.png) + +![Vidéo indiquant qu'on peut trouver le bouton YunoPaste en bas à droite des pages de logs sur la web admin](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted) +![Vidéo montrant qu'on peut partager un log depuis la web admin en allant dans Outils puis Services puis en sélectionnant le services dont on veut partager les logs](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted) Si votre problème n'est pas lié à un processus d'installation ou de mise à jour, mais plutôt à une application qui ne se charge pas correctement, vous pouvez déjà enquêter avec la console de votre navigateur (s'ouvrant avec la touche F12) : son onglet Réseau peut vous montrer les codes d'erreur HTTP (y compris les bien connus 403, 404, 500...), et sa Console peut également afficher des erreurs. @@ -39,15 +46,18 @@ Les captures d'écran sont les bienvenues. # À ne pas faire -## Évitez le [problème XY] (https://xyproblem.info/) +## Évitez le [problème XY](https://xyproblem.info/) + En résumé, expliquez la cause de votre problème. Vous pouvez faire part de votre tentative de solution, mais le *pourquoi* vous avez besoin de cette solution potentielle est le plus important. ## Ne soyez pas vague + Ne supposez pas que nous comprenons ce dont vous parlez, ne prenez pas de raccourcis, ne reformulez pas, ne simplifiez pas, n'éditorialisez pas les messages d'erreur. N'écrivez pas "ça ne marche pas", "ça ne veut pas", "ça ne se charge pas", ou d'autres phrases vides de sens. -Expliquez ce qui ne va pas et comment cela apparaît à l'écran. Il y a, par exemple, une différence importante entre une page complètement blanche et une page blanche avec un code d'erreur, même minimaliste. +Expliquez ce qui ne va pas et comment cela apparaît à l'écran. +Il y a, par exemple, une différence importante entre une page complètement blanche et une page blanche avec un code d'erreur, même minimaliste. ## Ne tournez pas autour du pot @@ -56,4 +66,5 @@ Il n'est pas nécessaire de demander l'autorisation pour demander de l'aide. Il Ne posez pas votre question comme un sondage, comme dans "Est-ce que quelqu'un a réussi à faire fonctionner l'application XY ?" Si cela ne fonctionne pas pour vous, expliquez directement le problème que vous avez rencontré, expliquez le contexte, partagez les logs. ## Ne soyez pas un trou du cul + L'accès au forum ou aux salons de discussion est un privilège qui peut être révoqué. diff --git a/pages/07.help/help.md b/pages/07.help/help.md index 4c3ea147..acb29ad7 100644 --- a/pages/07.help/help.md +++ b/pages/07.help/help.md @@ -9,28 +9,36 @@ routes: Even though YunoHost contributors try to continuously perfect it, YunoHost itself or this documentation are not free from bugs or flaw. To let us help you, however, you need to follow these guidelines. -Support is only available on [the forum](https://forum.yunohost.org?target=_blank) or our [chatrooms](/chat_rooms?target=_blank). +Support is only available on [the forum](https://forum.yunohost.org?target=_blank) or our [chatrooms](/chat_rooms?target=_blank). We are also on Mastodon, but we do not offer help on this platform. -To allow us to help you on the forum, you absolutely need to fill in the Support request template. +To allow us to help you on the forum, you absolutely need to fill in the Support request template, it will be displayed on message creation. # Dos ## Be courteous and patient -Help in the chatrooms or on the forum is given by our users and contributors, all volunteers. You may be in a hurry, you may be exhausted by fruitless trials... Have a break, have a sip of your preferred soothing beverage, then continue reading. We need you in a good mindset to help you. + +Help in the chatrooms or on the forum is given by our users and contributors, all volunteers. You may be in a hurry, you may be exhausted by fruitless trials or overwhelmed by unpleasant emotions... Have a break, have a sip of your preferred soothing beverage, breathe and once you've recovered your composure continue reading. We need you in a good mindset to help you. ## Explain the context -Your request needs to be stated in a complete but concise way. Explain plainly what you want to achieve and in what manner it is not working for you. + +Your request needs to be stated in a complete but concise way. Explain plainly what you want to achieve and in what manner it is not working for you. +Don't hesitate to provide any information that may be relevant, even things that may seem obvious, as the person(s) who will be trying to help you may need this information. ## Show errors and logs + This is absolutely paramount if YunoHost or a command fails. It always explains why, through a single error code or a full wall of seemingly illegible text. For the latter, YunoHost provides green "Share with YunoPaste" buttons when something fails or in the Services page of the webadmin. Click on it, it will open a new web page, and you can then share its URL. +We recommend that you share these logs in their entirety using the link generated by YunoPaste. +Avoid extracts from the logs, as decisive information may be elsewhere. +Also, avoid copying and pasting them into the forum, as it's unpleasant to go through them like that. Share the YunoPaste link. + ![YunoPaste button](image://yunopaste.png) -![YunoPaste from install error](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted) -![YunoPaste from service](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted) +![Video showing that the YunoPaste button can be found in the bottom right-hand side of log pages on web admin](image://yunopaste_install.mp4?loop=1&controls=0&autoplay=1&muted) +![Video showing how to share a log from the web admin by going to Tools then Services then selecting the service whose logs you want to share](image://yunopaste_service.mp4?loop=1&controls=0&autoplay=1&muted) If your issue is not related to an installation or upgrade process but instead is about an app failing load properly, ideally you can investigate with your browser console (opened with the F12 key): its Network tab can show you HTTP error codes (including the infamous 403, 404, 500...), and its Console can output errors too. @@ -39,14 +47,17 @@ Screenshots are most welcome. # Don'ts ## Avoid the infamous [XY Problem](https://xyproblem.info/) + In a nutshell, explain the root cause of your issue. You may share your attempted solution, but explaining ***why*** you need that potential solution is more important. ## Do not be vague + Do not assume we understand what you are talking about, do not take shortcuts, do not rephrase, do not simplify, do not trim the error messages. Do not write "it does not work", "it does not want", "it does not load", ["computer says no"](https://en.wikipedia.org/wiki/Computer_says_no). -Explain what is wrong, and how it is displayed onscreen. There is, for example, an important difference between a completely blank page and a blank page with a minimalistic error code. +Explain what is wrong, and how it is displayed onscreen. +There is, for example, an important difference between a completely blank page and a blank page with a minimalistic error code. ## Do not beat about the bush @@ -55,4 +66,5 @@ No need to ask if you can ask. It is a support chat/forum, therefore yes, you ca Do not ask your question like a poll, as in "Did anyone managed to get app XY working?". If it is not working for you, then explain directly what issue you got, explain the context, share the logs. ## Do not be an asshole + Access to the forum or the chatrooms is a courtesy that can be revoked.