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

Simple usage tutorial #49

Open
tiagofilipe12 opened this issue May 27, 2017 · 2 comments
Open

Simple usage tutorial #49

tiagofilipe12 opened this issue May 27, 2017 · 2 comments

Comments

@tiagofilipe12
Copy link
Member

@tiagofilipe12 tiagofilipe12 commented May 27, 2017

What do you think if we create a simple usage tutorial for some of the basic usages of tasks and orchestrators to README? We already have 4 examples but I think a walkthrough tutorial could help users to develop new pipelines.

@thejmazz
Copy link
Member

@thejmazz thejmazz commented May 29, 2017

Yes, this is definitely an important task if we wish to attract newcomers more easily.

I think a thorough walkthrough might include:

  • go through a short pipeline by hand (should be copy-pastable commands but still get point across that files are written/read across multiple programs)
  • show makefile/snakemake/nextflow and how they suffer when using multiple alternate params/programs for a pipeline step
  • show how watermill overcomes that (i.e reusable tasks across pipelines, fork)

Maybe we should have a "why" tutorial (i.e. the points above) as well as a "getting started" one. The why one would go through pitfalls of other tools/practices which explains the motivation for watermill. The getting started one explains how the pipeline DAG works and how to create tasks using

  • shell commands
  • JS functions
  • streams
@bmpvieira bmpvieira added this to Backlog in Bionode Project Board May 30, 2017
@bmpvieira bmpvieira moved this from Backlog to In Progress in Bionode Project Board Jun 2, 2017
@tiagofilipe12
Copy link
Member Author

@tiagofilipe12 tiagofilipe12 commented Jun 13, 2017

PR 55 should have handled the "getting started" tutorial as well as bionode-watermill-tutorial.
Regarding the "why", we could put a link to your blog in README as well as the "getting started" tutorial link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Bionode Project Board
  
In Progress
Watermill board
Documentation
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants