community/contributors/design-proposals/clustering
Michelle Noorali f4379b3c77 merge design and proposals docs 2016-11-30 14:47:43 -05:00
..
.gitignore merge design and proposals docs 2016-11-30 14:47:43 -05:00
Dockerfile merge design and proposals docs 2016-11-30 14:47:43 -05:00
Makefile merge design and proposals docs 2016-11-30 14:47:43 -05:00
README.md merge design and proposals docs 2016-11-30 14:47:43 -05:00
dynamic.png merge design and proposals docs 2016-11-30 14:47:43 -05:00
dynamic.seqdiag merge design and proposals docs 2016-11-30 14:47:43 -05:00
static.png merge design and proposals docs 2016-11-30 14:47:43 -05:00
static.seqdiag merge design and proposals docs 2016-11-30 14:47:43 -05:00

README.md

This directory contains diagrams for the clustering design doc.

This depends on the seqdiag utility. Assuming you have a non-borked python install, this should be installable with:

pip install seqdiag

Just call make to regenerate the diagrams.

Building with Docker

If you are on a Mac or your pip install is messed up, you can easily build with docker:

make docker

The first run will be slow but things should be fast after that.

To clean up the docker containers that are created (and other cruft that is left around) you can run make docker-clean.

Automatically rebuild on file changes

If you have the fswatch utility installed, you can have it monitor the file system and automatically rebuild when files have changed. Just do a make watch.

Analytics