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

Idea: troubleshooting example #23

Open
jayoung opened this issue Dec 2, 2022 · 1 comment
Open

Idea: troubleshooting example #23

jayoung opened this issue Dec 2, 2022 · 1 comment

Comments

@jayoung
Copy link
Contributor

jayoung commented Dec 2, 2022

hi,

The troubleshooting I did yesterday to get annovar working (together with an in-person troubleshoot with Amy last month) made me appreciate the value of understanding failures.

How about having a section of the tutorial where we supply a workflow we know isn't going to work?

We make it fail for some very simple reason, perhaps a problem we think will crop up often - maybe input files aren't found. The tutorial could walk the user through how they would troubleshoot that.

Troubleshooting example 1: today I specified the WDL file but forgot to specify the associated JSON input file before I clicked 'submit workflow'. It took me a while to figure out what I did wrong (and yes, now I know how to troubleshoot that, but I think some people would appreciate a walk-through of what to do with that 'submit jobs-troubleshoot' button).

Troubleshooting example 2: let's say the WDL and JSON are fine, but there's something wrong with the WDL code or perhaps the input files aren't available. Some people will figure out the troubleshooting from the 'track jobs' tab just fine, but I bet others would benefit from a walk-through.

what do you think?

Janet

@vortexing
Copy link
Contributor

I like it!! And so easy to break a workflow so this seems totally doable to do.

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

2 participants