Merge pull request #2430 from YunoHost/fixes

help pages: smol fixes
This commit is contained in:
tituspijean 2024-03-02 08:48:24 +01:00 committed by GitHub
commit 9955190a50
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 38 additions and 43 deletions

View file

@ -9,30 +9,30 @@ routes:
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.
# À faire
## À faire
## Patience et courtoisie
### Patience et courtoisie
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, que les essais infructueux vous épuisent ou encore que de mauvaises émotions vous submergent... 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.
## Demandez au bon endroit
### Demandez au bon endroit
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.
Sur le forum, assurez-vous d'ouvrir votre demande dans la bonne catégorie, afin de maximiser vos chances de recevoir l'aide appropriée :
- [Support](https://forum.yunohost.org/c/support/6?target=_blank) pour les problèmes lors de l'installation ou de l'utilisation de YunoHost en soit ;
- [Support](https://forum.yunohost.org/c/support/6?target=_blank) pour les problèmes lors de l'installation ou de l'utilisation de YunoHost en soi ;
- [Support apps](https://forum.yunohost.org/c/apps/11?target=_blank) pour les problèmes lors de la configuration ou de l'utilisation d'applications.
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.
## Expliquez le contexte
### 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.
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
### 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.
@ -51,13 +51,13 @@ Si votre problème n'est pas lié à un processus d'installation ou de mise à j
Les captures d'écran sont les bienvenues.
# À ne pas faire
## À 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 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.
@ -66,12 +66,12 @@ N'écrivez pas "ça ne marche pas", "ça ne veut pas", "ça ne se charge pas", o
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
### Ne tournez pas autour du pot
Il n'est pas nécessaire de demander l'autorisation pour demander de l'aide. Il s'agit d'un chat/forum d'assistance, donc oui, vous pouvez poser votre question.
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
### 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é.

View file

@ -14,15 +14,18 @@ Ci trovate anche su Mastodon, ma non forniamo aiuto su questa piattaforma.
Affinché ci sia possibile aiutarvi, sul forum dovete porre le domande seguendo il modello proposto.
# Come fare
## Come fare
### Siate gentili e pazienti
## Siate gentili e pazienti.
L'aiuto nei gruppi o sul forum viene fornito dai collaboratori e dagli utilizzatori, tutti volontari. A volte succede di avere fretta o essere stressati da tentativi infruttuosi... prendetevi una pausa, bevete un sorso della vostra bevanda rilassante preferita e poi rileggete. Abbiamo bisogno che siate in una buona condizione mentale per potervi aiutare.
## Spiegate il contesto.
### Spiegate il contesto
La richiesta di aiuto deve essere posta in maniera completa e concisa. Spiegate chiaramente cosa volete ottenere e cosa non riuscite a fare.
## Riportate gli errori e i log
### Riportate gli errori e i log
Di fondamentale importanza nelle richieste di aiuto è fornire log e messaggi di errore. Se un comando fallisce, YunoHost ci comunica sempre cosa succede, attraverso un codice di errore o un elenco di stringhe apparentemente incomprensibili.
Quando qualcosa non va come dovrebbe, trovate dei pulsanti di colore verde "Condividere con YunoPaste" nella pagina dei Servizi nella pagina webadmin. Cliccando sul pulsante si aprirà una pagina web della quale dovrete condividere l'URL.
@ -36,34 +39,26 @@ Se il vostro problema non è dovuto ad un processo di installazione o di aggior
Gli screenshot sono i benvenuti.
# Da non fare assolutamente
## Da non fare assolutamente
### Evitate il terribile [problema XY](https://xyproblem.info/)
## Evitate il terribile [problema XY](https://xyproblem.info/)
In breve, spiegate quando si verifica il problema. Potete illustrare i tentativi intrapresi per risolverlo ma è importante spiegare ***perché*** avete bisogno di questa particolare soluzione.
## Non siate vaghi
### Non siate vaghi
Non date per scontato che le vostre spiegazioni siano comprese, non usate scorciatoie, non abbreviate, non semplificate. Non abbreviate i messaggi di errore.
Non scrivete "non funziona", "non si installa", "non carica" e ["lo dice il computer"](https://en.wikipedia.org/wiki/Computer_says_no).
Spiegate cosa non va e come l'errore si manifesta a schermo. C'è una differenza fondamentale, ad esempio, tra una pagina completamente bianca e una pagina completamente bianca con un codice di errore minimale.
## Non "menate il can per l'aia"
### Non "menate il can per l'aia"
Non è necessario chiedere il permesso per chiedere aiuto. Trattandosi di una chat/forum di assistenza potete, ebbene sì, potete porre domande.
Non fate domande come fosse un sondaggio, ad esempio "Qualcuno è riuscito a fare andare l'applicazione XY?" Se riscontrate dei problemi con un'applicazione spiegate direttamente il problema riscontrato, illustrate il contesto e condividete i log.
## Non rompete le p...e
### Non rompete le p...e
La partecipazione al forum e alle chat è un privilegio che può essere rimosso.

View file

@ -9,13 +9,13 @@ 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.
# Dos
## Dos
## Be courteous and patient
### 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 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.
## Ask in the right place
### Ask in the right place
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.
@ -25,14 +25,14 @@ On the forum, make sure you open your request in the proper category, to maximiz
- [Support](https://forum.yunohost.org/c/support/6?target=_blank) for issues when setting up or using YunoHost itself;
- [Support apps](https://forum.yunohost.org/c/apps/11?target=_blank) for issues when setting up or using apps.
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.
To allow us to help you on the forum, you absolutely need to fill in the Support request template, it will be displayed upon message creation.
## Explain the context
### 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.
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
### 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.
@ -51,13 +51,13 @@ If your issue is not related to an installation or upgrade process but instead i
Screenshots are most welcome.
# Don'ts
## Don'ts
## Avoid the infamous [XY Problem](https://xyproblem.info/)
### 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 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.
@ -66,12 +66,12 @@ Do not write "it does not work", "it does not want", "it does not load", ["compu
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
### Do not beat about the bush
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
### Do not be an asshole
Access to the forum or the chatrooms is a courtesy that can be revoked.