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

Add troubleshooting doc #418

Open
mfisher87 opened this issue Dec 22, 2023 · 3 comments
Open

Add troubleshooting doc #418

mfisher87 opened this issue Dec 22, 2023 · 3 comments
Labels
good first issue Good for newcomers impact: documentation Improvements or additions to documentation

Comments

@mfisher87
Copy link
Collaborator

What steps do we usually suggest to users to troubleshoot common issues?

e.g.:

Why did I not get the search results I expected? Try setting debug=True.

@mfisher87 mfisher87 added impact: documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 22, 2023
@andypbarrett
Copy link
Collaborator

Starting a list of initial problem solving steps but also add links to relevant how tos.

  • I cannot read a variable from nested HDF5 with xarray. Solution: use the group keyword. Link to a how-to.

@mfisher87
Copy link
Collaborator Author

mfisher87 commented Feb 6, 2024

How do we get ourselves in the habit, or remind ourselves programmatically, to update this troubleshooting doc as new questions from users come in? 🤔

@jessnicwelch
Copy link
Collaborator

How do we get ourselves in the habit, or remind ourselves programmatically, to update this troubleshooting doc as new questions from users come in? 🤔

I think we should make a discussion area for posting the ideas/needed updates and then encourage people to tackle them during IP Sprint. For people who don't understand that, it's a dedicated two weeks each quarter to reduce technical debt and to learn new things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers impact: documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

3 participants