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

Update Troubleshooting guide #540

Open
munishchouhan opened this issue Jun 25, 2024 · 0 comments
Open

Update Troubleshooting guide #540

munishchouhan opened this issue Jun 25, 2024 · 0 comments
Assignees

Comments

@munishchouhan
Copy link
Member

munishchouhan commented Jun 25, 2024

Suggestions from @ewels:


Just looking at the new troubleshooting docs quickly. Are these general use for all Wave users? I think that we could write quite a lot more detail if so. The main thing that I would find useful as an end user is a list of typical reasons for failures:

  • Bioconda build failed
  • Timed out
  • Out of memory

Others (making this up as guesses, so imagined errors)

  • Base image not found?
  • Invalid Dockerfile syntax?
  • Invalid conda file syntax?
  • Authentication error?
  • ...and so on

Each error type should have its own heading and an example snippet (code block from logs, not a screenshot).
Then importantly, each section should say what to do next. For example, the current docs mention memory:

e.g. if it is 137 that means out of memory error.

But it doesn't tell me what I can do about it. So it doesn't really help me as an end user. We need that for each category of error.

The error / solution sections of example 2 is better. Except that one doesn't explain why the error happens or when it might happen, or why the solutions work.

@munishchouhan munishchouhan self-assigned this Jun 25, 2024
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