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 issues #6

Open
5 of 16 tasks
illusional opened this issue Jan 28, 2020 · 0 comments
Open
5 of 16 tasks

Documentation issues #6

illusional opened this issue Jan 28, 2020 · 0 comments
Labels
documentation Requires documentation

Comments

@illusional
Copy link
Member

illusional commented Jan 28, 2020 •
edited

An issue to keep tabs on documentation, and which things need to be documented:

General

  • Engine comparison
    • Call-caching
    • Debugging
    • Logging
    • Execution environment support
  • Conditionals - relies on Conditionals in Janis janis-core#5
  • WES / TES - How does Janis complement these specifications (notes have been prepared)
  • How to collect outputs in a Tool
  • Collaborations
  • Container overrides

Tutorials

  • How to debug Janis + Cromwell
  • Building a WGS pipeline
  • Renaming your outputs
    • How to ensure your output has a specific extension.
  • Configuring Janis for HPCs
  • How to add and test a tool into the Janis repo

Contributing

  • Contributing Guide
  • Open source comments [SHEP-46]
  • Types of conditionals

Tool registries

  • Why it's structured the way it is

Workshops

TBA
@illusional illusional mentioned this issue Mar 16, 2020
Merged
@illusional illusional added the documentation Requires documentation label Mar 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Requires documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@illusional