From 0757b6cd151202ddcce6466c3a8e91fec682c165 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Wed, 4 Oct 2023 09:35:54 +0200 Subject: [PATCH] Improve general help page Co-authored-by: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> --- pages/07.help/help.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/pages/07.help/help.md b/pages/07.help/help.md index 750eb5ae..1e1ccf7c 100644 --- a/pages/07.help/help.md +++ b/pages/07.help/help.md @@ -7,7 +7,7 @@ routes: default: '/help-me' --- -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 come prepared. +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. # Dos @@ -23,10 +23,11 @@ This is absolutely paramount if YunoHost or a command fails. It always explains 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. ![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) -If a page fails to load properly, learn to 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. +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. Screenshots are most welcome. @@ -35,16 +36,21 @@ To guide you, on the forum you need to fill in the Support request template. # 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 why you need that potential solution is more important. +In a nutshell, explain the root cause of your issue. You may share your attempted solution, but *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). -Do not ask your question like a poll, as in "does anyone else has...". Most likely very few people have the same issue or need as you, and even less read the forum or the chatrooms. - 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. +## Directly ask your question + +No need to ask if you can ask. It is a support chat/forum, therefore yes, you can ask your question. + +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.