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

Produce a clear and concise documentation for each Dockerfile #2

Closed
davidonlaptop opened this issue Feb 20, 2015 · 7 comments
Closed
Assignees
Milestone

Comments

@davidonlaptop
Copy link
Member

All Dockerfile should be documented using a README on GitHub and on the Docker Hub front page (ideally, this should be the same file).

Good examples include Docker's Jenkins or MySQL images.

At the minimum, we should have these infos (taking Adam as an example):

  • What is Adam ?
  • What is Docker and what is a Docker image ?
  • Dependencies (*)
  • How to use this image? (**)

(*) The dependencies include Docker, and the Base Docker Image. When we used different branches (src vs released version), we should also document which branch uses which base docker image.
(**) In the case of Snap, Adam, Avocado, we should put a small example which downloads (wget) a chromosome from 1000 Genome project's ftp and run each tool.

@flangelier
Copy link
Contributor

Snap done

@flangelier
Copy link
Contributor

adam done

@flangelier
Copy link
Contributor

spark done

@flangelier
Copy link
Contributor

scala done

@flangelier
Copy link
Contributor

Java done

Remaining:
Avocado
Hadoop

@flangelier
Copy link
Contributor

Hadoop done

Remaining:
Avocado

@flangelier
Copy link
Contributor

Done for avocado!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants