decaporg / decap-cms

A Git-based CMS for Static Site Generators
https://decapcms.org
MIT License
17.84k stars 3.04k forks source link

Modify issue reporting invitation text to improve the quality of reports #6904

Open samo4 opened 1 year ago

samo4 commented 1 year ago

Improve issue reporting invitation text to improve the quality of reports (and reduce duplicates or support requests).

Existing text:

image

Proposed text:

There's been an error. It might be related to your hosting provider, Git backend provider, Decap configuration, or it might be an actual bug in Decap CMS. Please try to exclude the first three possibilities, ideally by asking for assistance on our Discord support channel. Once you're reasonably sure it's a Decap CMS bug, verify if a similar issue has already been reported: if it has, comment and upvote the issue; if not, open a new issue on GitHub. Opening an issue pre-populates it with the error message and debugging data, but this is just the beginning of writing an issue. You need to explain the issue in detail, explain what you were doing just before the issue occurred, list all possible solutions you tried before opening the issue and include a screenshot.

martinjagodic commented 11 months ago

This is complicated because this message is translated into many languages.

We have 2 options:

a) Display English for all locales. b) Translate with a service like Google Translate for at least some of the locales.

samo4 commented 11 months ago

Chat GPT giving back:

Spanish:

"Ha ocurrido un error. Puede estar relacionado con su proveedor de alojamiento, proveedor de backend de Git, configuración de Decap, o podría ser un error real en Decap CMS. Intente excluir las tres primeras posibilidades, idealmente pidiendo ayuda en nuestro canal de soporte de Discord. Una vez que esté razonablemente seguro de que se trata de un error de Decap CMS, verifique si se ha informado un problema similar: si es así, comente y vote a favor del problema; si no, abra un nuevo problema en GitHub. Al abrir un problema, se prepopula con el mensaje de error y los datos de depuración, pero esto es solo el comienzo de escribir un problema. Debe explicar el problema en detalle, explicar lo que estaba haciendo justo antes de que ocurriera el problema, enumerar todas las posibles soluciones que intentó antes de abrir el problema e incluir una captura de pantalla."

French:

"Il y a eu une erreur. Cela pourrait être lié à votre hébergeur, au fournisseur Git en arrière-plan, à la configuration Decap, ou il pourrait s'agir d'un véritable bogue dans Decap CMS. Essayez d'exclure les trois premières possibilités, de préférence en demandant de l'aide sur notre canal de support Discord. Une fois que vous êtes raisonnablement sûr qu'il s'agit d'un bogue de Decap CMS, vérifiez si un problème similaire a déjà été signalé : si c'est le cas, commentez et votez pour le problème ; sinon, ouvrez un nouveau problème sur GitHub. L'ouverture d'un problème préremplit ce dernier avec le message d'erreur et les données de débogage, mais ce n'est que le début de la rédaction d'un problème. Vous devez expliquer le problème en détail, expliquer ce que vous faisiez juste avant que le problème ne se produise, énumérer toutes les solutions possibles que vous avez essayées avant d'ouvrir le problème et inclure une capture d'écran."

German:

"Es ist ein Fehler aufgetreten. Dies könnte mit Ihrem Hosting-Anbieter, dem Git-Backend-Anbieter, der Decap-Konfiguration zusammenhängen oder es könnte sich um einen tatsächlichen Fehler in Decap CMS handeln. Versuchen Sie, die ersten drei Möglichkeiten auszuschließen, idealerweise indem Sie um Hilfe in unserem Discord-Supportkanal bitten. Sobald Sie ziemlich sicher sind, dass es sich um einen Decap-CMS-Bug handelt, überprüfen Sie, ob ein ähnliches Problem bereits gemeldet wurde: Wenn ja, kommentieren Sie es und stimmen Sie dafür; wenn nicht, öffnen Sie ein neues Problem auf GitHub. Das Öffnen eines Problems füllt dieses mit der Fehlermeldung und Debugging-Daten vor, aber das ist nur der Anfang des Verfassens eines Problems. Sie müssen das Problem im Detail erklären, erläutern, was Sie kurz vor dem Auftreten des Problems getan haben, alle möglichen Lösungen auflisten, die Sie vor dem Öffnen des Problems ausprobiert haben, und einen Screenshot hinzufügen."

Portuguese (Brazil):

"Houve um erro. Isso pode estar relacionado ao seu provedor de hospedagem, provedor de backend do Git, configuração do Decap, ou pode ser um bug real no Decap CMS. Tente excluir as três primeiras possibilidades, idealmente pedindo ajuda em nosso canal de suporte no Discord. Uma vez que você esteja razoavelmente certo de que é um bug no Decap CMS, verifique se um problema semelhante já foi relatado: se for o caso, comente e vote a favor do problema; caso contrário, abra um novo problema no GitHub. A abertura de um problema preenche-o com a mensagem de erro e dados de depuração, mas isso é apenas o início da redação do problema. Você precisa explicar o problema em detalhes, explicar o que estava fazendo imediatamente antes do problema ocorrer, listar todas as soluções possíveis que tentou antes de abrir o problema e incluir uma captura de tela."

Dutch:

"Er is een fout opgetreden. Dit kan te maken hebben met uw hostingprovider, Git-backendprovider, Decap-configuratie of het kan een daadwerkelijke bug in Decap CMS zijn. Probeer de eerste drie mogelijkheden uit te sluiten, bij voorkeur door hulp te vragen in ons Discord-ondersteuningskanaal. Zodra u redelijk zeker weet dat het een bug in Decap CMS is, controleer dan of een vergelijkbaar probleem al is gemeld: als dat het geval is, reageer dan en geef het probleem een upvote; zo niet, open een nieuw probleem op GitHub. Het openen van een probleem vult dit in met de foutmelding en debuggegevens, maar dit is slechts het begin van het schrijven van een probleem. U moet het probleem in detail uitleggen, uitleggen wat u deed vlak voordat het probleem optrad, alle mogelijke oplossingen opsommen die u hebt geprobeerd voordat u het probleem opende, en een schermafbeelding toevoegen."

Chinese (Simplified):

"发生了一个错误。这可能与您的托管提供商、Git 后端提供商、Decap 配置有关,或者可能是 Decap CMS 的实际错误。请尽量排除前三种可能性,最好是在我们的 Discord 支持频道寻求帮助。一旦您相当确信这是 Decap CMS 的错误,就要验证是否已经报告了类似的问题:如果已经报告了,就评论并投赞成该问题;如果没有,就在 GitHub 上打开一个新的问题。打开问题会预填写错误消息和调试数据,但这只是写问题的开始。您需要详细说明问题,解释问题发生前您正在做什么,列出在打开问题之前尝试的所有可能解决方案,并包含屏幕截图。"

Japanese:

"エラーが発生しました。これはホスティングプロバイダー、Gitバックエンドプロバイダー、Decapの設定に関連しているかもしれませんし、Decap CMSの実際のバグかもしれません。まず、最初の3つの可能性を排除するよう努力し、理想的にはDiscordのサポートチャンネルでの支援を求めてみてください。Decap CMSのバグであることがほぼ確信できたら、類似の問題が既に報告されているか確認してください。もし既に報告されている場合、その問題にコメントを追加し、アップボートしてください。報告されていない場合は、GitHubで新しい問題を開いてください。問題を開くと、エラーメッセージとデバッグデータが事前に設定されますが、これは問題の執筆の始まりに過ぎません。問題を詳細に説明し、問題が発生する直前に行っていたことを説明し、問題を開く前に試したすべての可能な解決策をリストアップし、スクリーンショットを含める必要があります。"

Korean:

"오류가 발생했습니다. 이는 호스팅 제공업체, Git 백엔드 제공업체, Decap 구성과 관련이 있을 수 있으며, Decap CMS의 실제 버그일 수도 있습니다. 처음 세 가지 가능성을 제외하려 노력하고 Discord 지원 채널에서 도움을 요청하는 것이 이상적입니다. Decap CMS 버그임을 상당히 확신하면 비슷한 문제가 이미 보고되었는지 확인하십시오. 이미 보고된 경우 문제에 댓글을 달고 문제에 투표하십시오. 그렇지 않은 경우 GitHub에서 새로운 문제를 열어주세요. 문제를 열면 오류 메시지 및 디버깅 데이터가 자동으로 채워집니다. 그러나 이것은 문제 작성의 시작에 불과합니다. 문제를 자세히 설명하고 문제가 발생하기 직전에 수행한 작업을 설명하며 문제를 열기 전에 시도한 모든 가능한 해결책을 나열하고 스크린샷을 첨부해야 합니다."

Italian:

"Si è verificato un errore. Questo potrebbe essere legato al vostro provider di hosting, al provider del backend Git, alla configurazione di Decap, oppure potrebbe essere un effettivo bug in Decap CMS. Provate a escludere le prime tre possibilità, possibilmente chiedendo assistenza sul nostro canale di supporto Discord. Una volta che siete ragionevolmente sicuri che si tratti di un bug in Decap CMS, verificate se è già stato segnalato un problema simile: in tal caso, commentate e votate il problema; in caso contrario, aprite una nuova segnalazione su GitHub. L'apertura di una segnalazione la precompila con il messaggio di errore e i dati di debug, ma questo è solo l'inizio della stesura di una segnalazione. Dovete spiegare il problema in dettaglio, spiegare cosa stavate facendo prima che si verificasse il problema, elencare tutte le possibili soluzioni che avete provato prima di aprire la segnalazione e includere uno screenshot."

Russian (Русский):

"Произошла ошибка. Это может быть связано с вашим хостинг-поставщиком, поставщиком Git-бэкэнда, настройкой Decap или это может быть настоящей ошибкой в Decap CMS. Попробуйте исключить первые три возможности, желательно, обратившись за помощью на нашем Discord-канале поддержки. Как только вы уверены, что это ошибка Decap CMS, проверьте, был ли уже зарегистрирован аналогичный случай: если так, оставьте комментарий и проголосуйте за проблему; в противном случае, откройте новую задачу на GitHub. Открытие задачи автоматически заполняет ее текстом ошибки и данными отладки, но это лишь начало написания задачи. Вы должны подробно объяснить проблему, описать, что вы делали непосредственно перед возникновением проблемы, перечислить все возможные решения, которые вы пробовали до открытия задачи, и прикрепить скриншот."

Ukrainian (Українська):

"Сталася помилка. Це може бути пов'язано з вашим постачальником хостингу, постачальником Git-бекенду, конфігурацією Decap або це може бути справжньою помилкою в Decap CMS. Спробуйте виключити перші три можливості, найкраще, звернувшись за допомогою на нашому каналі підтримки у Discord. Якщо ви впевнені, що це помилка Decap CMS, перевірте, чи вже було подібне питання зареєстровано: якщо так, залиште коментар і проголосуйте за проблему; в іншому випадку відкрийте нове завдання на GitHub. Відкриття завдання автоматично заповнює його текстом помилки та даними для налагодження, але це лише початок написання завдання. Ви повинні докладно пояснити проблему, описати, що ви робили безпосередньо перед виникненням проблеми, перерахувати всі можливі рішення, які ви випробували до відкриття завдання, і додати знімок екрану."

Danish:

"Der opstod en fejl. Dette kan skyldes din hosting-udbyder, Git backend-udbyderen, Decap-konfigurationen eller det kan være en reel fejl i Decap CMS. Forsøg at udelukke de første tre muligheder, helst ved at bede om hjælp i vores Discord-supportkanal. Når du er rimeligt sikker på, at det er en Decap CMS-fejl, skal du kontrollere, om der allerede er blevet rapporteret et lignende problem: Hvis det er tilfældet, skal du kommentere og give problemet en upvote; hvis ikke, skal du åbne en ny sag på GitHub. At åbne en sag udfylder den med fejlmeddelelsen og fejlfindingdata, men det er kun begyndelsen på at skrive en sag. Du skal forklare problemet i detaljer, forklare hvad du gjorde lige inden problemet opstod, liste alle mulige løsninger, du prøvede, inden du åbnede sagen, og inkludere et skærmbillede."

Swedish:

"Ett fel har inträffat. Detta kan bero på din värdleverantör, Git-backend-leverantören, Decap-konfigurationen eller det kan vara en faktisk bugg i Decap CMS. Försök att utesluta de tre första möjligheterna, helst genom att be om hjälp i vår Discord-supportkanal. När du är rimligt säker på att det är en bugg i Decap CMS, kontrollera om ett liknande problem redan har rapporterats: om det har det, kommentera och rösta för problemet; om inte, öppna en ny fråga på GitHub. Att öppna en fråga förifyller den med felmeddelandet och felsökningsdata, men det är bara början på att skriva en fråga. Du måste förklara problemet i detalj, förklara vad du gjorde precis innan problemet uppstod, lista alla möjliga lösningar du försökte innan du öppnade frågan och inkludera en skärmbild."

Norwegian:

"Det har oppstått en feil. Dette kan være relatert til din hosting-leverandør, Git backend-leverandør, Decap-konfigurasjonen, eller det kan være en faktisk feil i Decap CMS. Forsøk å ekskludere de tre første mulighetene, helst ved å be om hjelp i vårt Discord-supportkanal. Når du er rimelig sikker på at det er en Decap CMS-feil, sjekk om et lignende problem allerede er rapportert: Hvis det er tilfelle, kommenter og gi problemet en oppstemme; hvis ikke, åpne en ny sak på GitHub. Åpning av en sak forhåndsutfyller den med feilmeldingen og feilsøkingsdata, men dette er bare begynnelsen på å skrive en sak. Du må forklare problemet i detalj, forklare hva du gjorde rett før problemet oppstod, liste opp alle mulige løsninger du prøvde før du åpnet saken, og inkludere et skjermbilde."

Finnish:

"Jokin meni pieleen. Tämä saattaa liittyä webhotellipalveluntarjoajaanne, Git-taustapalveluntarjoajaan, Decapin määritykseen tai se voi olla Decap CMS:n todellinen virhe. Yrittäkää ensin sulkea pois ensimmäiset kolme mahdollisuutta, mieluiten pyytämällä apua Discord-tukikanavassamme. Kun olette kohtuullisen varmoja, että kyseessä on Decap CMS -virhe, tarkistakaa, onko samanlainen ongelma jo raportoitu: jos on, kommentoikaa ja äänestäkää ongelmaa; jos ei, avatkaa uusi ongelma GitHubissa. Ongelman avaaminen täyttää sen virheilmoituksella ja vianmääritystiedoilla, mutta tämä on vasta ongelman kirjoittamisen alku. Teidän on selitettävä ongelma yksityiskohtaisesti, kertoa, mitä olitte tekemässä juuri ennen ongelman ilmenemistä, luetella kaikki mahdolliset ratkaisuyritykset ennen ongelman avaamista ja liittää mukaan näyttökuva."

Czech:

"Nastala chyba. Může to souviset s vaším hostingovým poskytovatelem, poskytovatelem Git backendu, konfigurací Decap, nebo může jít o skutečnou chybu v Decap CMS. Snažte se vyloučit první tři možnosti, ideálně tím, že požádáte o pomoc na našem Discord podpoře. Jakmile jste dostatečně jisti, že jde o chybu v Decap CMS, zkontrolujte, zda byl nahlášen podobný problém: pokud ano, komentujte a hlasujte pro tento problém; pokud ne, otevřete nový problém na GitHubu. Otevření problému ho automaticky vyplní chybovou zprávou a údaji o ladění, ale to je jen začátek psaní problému. Musíte problém podrobně popsat, vysvětlit, co jste dělali těsně před vznikem problému, vypsat všechna možná řešení, která jste zkoušeli před otevřením problému, a přiložit screenshot."

Polish:

"Zdążył wystąpić błąd. Może to być związane z dostawcą hostingu, dostawcą backendu Git, konfiguracją Decap lub może to być rzeczywisty błąd w Decap CMS. Spróbuj wykluczyć pierwsze trzy możliwości, najlepiej pytając o pomoc na naszym kanale wsparcia Discord. Gdy jesteś dość pewny, że to błąd Decap CMS, sprawdź, czy podobny problem nie został już zgłoszony: jeśli tak, dodaj komentarz i zagłosuj na problem; jeśli nie, otwórz nowy problem na GitHubie. Otwarcie problemu wypełni go treścią błędu i danymi debugowania, ale to tylko początek pisania problemu. Musisz szczegółowo opisać problem, wyjaśnić, co robiłeś tuż przed wystąpieniem problemu, wymienić wszystkie możliwe rozwiązania, które próbowałeś przed otwarciem problemu i dołączyć zrzut ekranu."

Turkish:

"Bir hata oluştu. Bu, barındırma sağlayıcınızla, Git arka uç sağlayıcısıyla, Decap yapılandırmasıyla ilgili olabilir veya Decap CMS'de gerçek bir hata olabilir. İlk üç olasılığı dışlamak için Discord destek kanalımızda yardım isteyerek ideal olarak başlayın. Decap CMS hatası olduğundan oldukça emin olduğunuzda, benzer bir sorunun zaten bildirilip bildirilmediğini kontrol edin: eğer öyleyse, soruna yorum ekleyin ve sorunu oylandırmak için kullanın; aksi takdirde GitHub'da yeni bir sorun açın. Bir sorun açmak, hata mesajı ve hata ayıklama verileriyle doldurur, ancak bu bir sorun yazmanın sadece başlangıcıdır. Sorunu detaylı bir şekilde açıklamanız, sorunun oluşmadan önce ne yaptığınızı açıklamanız, sorunu açmadan önce denediğiniz tüm olası çözümleri sıralamanız ve bir ekran görüntüsü eklemeniz gerekir."

Hungarian:

"Hiba történt. Ez a tárhelyszolgáltatójához, a Git háttér szolgáltatójához, a Decap konfigurációhoz vagy akár egy tényleges hibához is kapcsolódhat a Decap CMS-ben. Próbálja meg kizárni az első három lehetőséget, lehetőleg segítséget kérve Discord támogatási csatornánkon. Amint viszonylag biztos benne, hogy a Decap CMS hibája, ellenőrizze, hogy hasonló problémát már bejelentettek-e: ha igen, akkor kommentelje meg és voksoljon a problémára; ha nem, nyisson egy új problémát a GitHubon. A probléma megnyitása automatikusan kitölti a hibaüzenetet és hibaelhárítási adatokat, de ez csak a probléma írásának kezdete. Részletesen el kell magyarázni a problémát, le kell írni, mit tett a probléma előtt, felsorolni az összes lehetséges megoldást, amelyeket megpróbált a probléma megnyitása előtt, és be kell szúrnia egy képernyőképet."

Greek:

"Προέκυψε ένα σφάλμα. Αυτό μπορεί να σχετίζεται με τον φορέα φιλοξενίας, τον πάροχο του Git backend, τη ρύθμιση του Decap, ή μπορεί να είναι πραγματικό σφάλμα στο Decap CMS. Δοκιμάστε να αποκλείσετε τις πρώτες τρεις πιθανότητες, είτε ζητώντας βοήθεια στο κανάλι υποστήριξης μας στο Discord, είτε με άλλον τρόπο. Μόλις είστε αρκετά βέβαιοι ότι πρόκειται για σφάλμα του Decap CMS, ελέγξτε αν έχει ήδη αναφερθεί παρόμοιο πρόβλημα: αν έχει, σχολιάστε το και ψηφίστε το πρόβλημα· αν όχι, ανοίξτε ένα νέο πρόβλημα στο GitHub. Η ανοιγμή ενός προβλήματος προσθέτει αυτόματα το μήνυμα σφάλματος και τα δεδομένα αποσφαλμάτωσης, αλλά αυτό είναι μόνο η αρχή της σύνταξης ενός προβλήματος. Πρέπει να εξηγήσετε λεπτομερώς το πρόβλημα, να εξηγήσετε τι κάνατε αμέσως πριν το πρόβλημα, να καταγράψετε όλες τις πιθανές λύσεις που δοκιμάσατε πριν ανοίξετε το πρόβλημα και να περιλαμβάνετε ένα στιγμιότυπο οθόνης."

Spanish:

"Ha ocurrido un error. Esto podría estar relacionado con su proveedor de hosting, el proveedor del backend de Git, la configuración de Decap, o podría ser un error real en Decap CMS. Intente excluir las tres primeras posibilidades, idealmente pidiendo ayuda en nuestro canal de soporte de Discord. Una vez que esté razonablemente seguro de que se trata de un error de Decap CMS, verifique si ya se ha reportado un problema similar: si es así, comente y vote a favor del problema; si no, abra un nuevo problema en GitHub. La apertura de un problema prellena el mensaje de error y los datos de depuración, pero esto es solo el comienzo de escribir un problema. Debe explicar el problema en detalle, explicar lo que estaba haciendo justo antes de que ocurriera el problema, listar todas las posibles soluciones que intentó antes de abrir el problema e incluir una captura de pantalla."

samo4 commented 11 months ago

I vote for the following solution: we start with "display all in english" and then invite ppl that have some understanding of the language to either retranslate or take ChatGPT version and make it somewhat non offensive.

samo4 commented 11 months ago

On second thought: whoever is reporting a bug should be able to write it in english - otherwise it will not help us. So I guess opion a is really best.

martinjagodic commented 11 months ago

Yes, we use English for issues. But not everyone who sees this error message will submit an issue. I believe that 99% of these errors are shown to editors - regular users, who should be able to read them in the current locale.