Document what stratotemplate makes, not just how it makes it

hammerlab / stratotemplate

DEPRECATED: we don't really maintain this any more, we use Coclobas:

https://github.com/hammerlab/coclobas

Apache License 2.0

2 stars 0 forks source link

Open hammer opened 7 years ago

hammer commented 7 years ago

README.md is a great quickstart. We should also document what kind of cluster is being created and what it can do.

hammer commented 7 years ago

I think a diagram would be useful, showing: user's local machine --> GClouder GCE node which creates Ketrew Server, NFS filers, and compute cluster.

We should then show the Docker image running w/in the GCloudera GCE node for certain commands, noting that it has a sane OCaml configuration.

Also documenting the various NFS filers that are listed by default in configuration.env would be helpful.