Write Documentation - Githubissues

bcgsc / orca

:whale: Genomics Research Container Architecture

http://www.bcgsc.ca/services/orca

GNU General Public License v3.0

48 stars 13 forks source link

Write Documentation #34

Closed tmozgach closed 6 years ago

tmozgach commented 6 years ago

How to set up Docker, Docker Swarm, create accounts etc.

tmozgach commented 6 years ago

@sjackman do you have any templates, platforms, where and what exactly I should write down?

sjackman commented 6 years ago

This is a bit different than a normal software package, but you can take a look these: https://github.com/linuxbrew/brew#readme https://github.com/bcgsc/abyss#readme https://github.com/bcgsc/tigmint#readme

tmozgach commented 6 years ago

Outline:

Introduction: ORCA(features) Container, Docker
Docker installation (just provide links): Mac Ox Linux Windows
Orca installation: Pull image, provide the usage (example of Hackseq log in script) GUI (links to Xquarts etc.)
Support

tmozgach commented 6 years ago

@sjackman could you look at the scratch plan? Anything else to add? Also I am wondering where should I write down this documentation?

sjackman commented 6 years ago

The outline looks good! You can put Introduction, Installation, and Support in the main README.md. If you find it's getting unwieldy, you can create files in the docs folder of this repo. Or if you prefer, you could put it all in the docs folder and create a link to it from the main README.md.

tmozgach commented 6 years ago

Done! https://github.com/bcgsc/orca/tree/master/docs