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.

Sign up for GitHub

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

Jump to bottom

Documentation tasks #17

Open
2 of 4 tasks
eric-czech opened this issue Sep 1, 2020 · 1 comment
Open
2 of 4 tasks

Documentation tasks #17

eric-czech opened this issue Sep 1, 2020 · 1 comment

Comments

@eric-czech
Copy link
Collaborator

eric-czech commented Sep 1, 2020 •
edited
Loading

TODOs related to documentation:

  • Separate commands in README into those that produce minimal results and those that are useful on-demand (i.e. monitoring and scaling commands)
  • Add separate GKE and DCP instruction sections
  • Add a diagram explaining how the different clusters and client machines relate to one another
    • This isn't really necessary, but I always appreciate any info like this in pipeline docs since maintainers often assume it as common knowledge
  • Add some nice visual from snakemake --dag
@eric-czech eric-czech mentioned this issue Sep 1, 2020
Open
28 tasks
@eric-czech
Copy link
Collaborator Author

For reference:

snakemake --default-remote-provider=GS --default-remote-prefix=rs-ukb --dag | dot -Tsvg > dag.svg

currently produces:

Screen Shot 2020-08-31 at 6 54 37 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@eric-czech