Docs link for every error

[alanna]

We could have an error page in docs and every time a user sees an error it links to the right section of that page to find out more. Currently it's confusing for users what errors mean and where they are coming from (OC, host, payment processor etc). Every time a dev codes in an error message, it should be documented and linked.

[Betree]

Big +1 on this, should definitely be part of #1810.

[piamancini]

• Scoping discussion - link notes here @znarf

[znarf]

Q2 Sprint 2 Week 3

• The case for it
  • Contribution Errors
    • No payment method available
  • Payment Errors
    • Various Stripe error codes
  • Expense Errors
    • PayPal / Wise
  • Errors where we say contact support@opencollective.com
• Identify errors
  • GraphQL API errors (throw Errors)
    • RFC to clarify future best practices
    • Code / Message / Link
    • Maintain Error messages in a way that can be exported
  • Express Errors / Webhook errors
    • Convention on how to report errors based on the mime type
      • JSON, text, html
  • Frontend errors
    • Forward GraphQL errors
    • Form validation (straightforward)
    • Crashs (nothing to do there)
  • Notifications
    • Recurring Contribution error
    • Expense payment error
  • Cron / Scripts
• Monitoring / Report errors
  • Should we report everything? Only non-handled ?
  • Report rest, cron and scripts errors
  • Ignore known errors
• Expose Errors
  • Keep same design
  • Try to localize
  • Add a link to documentation
  • How to know if we have the documentation or not?
    • Hardcode on the API side
    • Synchronize list
• Publish documentation
  • https://docs.opencollective.com/help/errors/rate-limited
  • https://opencollective.com/errors/rate-limited]
• Localisation
  • have error strings available on the Frontend and start localizing
• What is the ultimate goal?
  • Reduce support? Avoid back and forth when we have canned answers already ready.
  • Holistic. Best practice. Enhance trust.
  • Localization.
• Pilot
  • Stripe
  • Transferwise

Conclusion, we'll create a pilot project to document a set of errors in a new way that should potentially set the best practices for the future.

[shannondwray]

Bringing over from #6301

Who is your user?
Any user who is experiencing a bug or error

What are they trying to achieve?
When an error occurs on the platform, I want to provide the user with instructions to contact support and inform them of the error code, so I can have a better understanding of what’s going on rather than just getting an error code

Even better this would automatically notify the engineering team and we could then let the user know when this error has been resolved

How are they currently doing this?
An error code just displays