Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create FAQ to address common issues #393

Closed
Tracked by #345 ...
jsdw opened this issue Jan 13, 2022 · 2 comments
Closed
Tracked by #345 ...

Create FAQ to address common issues #393

jsdw opened this issue Jan 13, 2022 · 2 comments

Comments

@jsdw
Copy link
Collaborator

jsdw commented Jan 13, 2022

There appear to be common themes amoung many of the issues submitted to this repository, including:

  • Issues that would be resolved by rebuilding against latest metadata
  • Issues that require custom Extra config, (or other customisation)

The error messages that people run into can be confusing, and it's often not imemdiately obvious how to resolve them.

Some of this can (and should where possible) be addressed by code changes, but until then we might be able to reduce the volume of new issues by providing an FAQ which highlights common errors that can occur, and fixes for them.

This should be made as visible as possible when people come to report new issues, so perhaps it could be linked to as part of the default "New Issue" template to nudge users towards it first.

@jsdw jsdw changed the title Create FAQ to address common issues and link in New Issue template Create FAQ to address common issues Jan 13, 2022
@jsdw
Copy link
Collaborator Author

jsdw commented Jan 28, 2022

Eg: #399 (comment) (solution; regenerate metadata)

@jsdw jsdw mentioned this issue Feb 1, 2022
16 tasks
@jsdw
Copy link
Collaborator Author

jsdw commented Apr 6, 2023

Will think about this in #898 and close here

@jsdw jsdw closed this as completed Apr 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant