Canary

Canary is a blueprint for defining monitoring data artifacts in a visual manner.

• Prerequisites
• Quick Install
• Local Deployment
• Roll Your Own
• Code Organization

Prerequisites

Canary is hosted on GitHub using GitHub Pages. It can be served locally using Jekyll with Ruby 2.0.0 or greater. Click here to download and install Ruby. If you have Ruby, but aren’t sure which version, run ruby -v.

Quick Install

Clone from GitHub and go into the directory.

$ git clone -b gh-pages https://github.com/caleorourke/canary.git
$ cd canary

Install Grunt's CLI.

$ [sudo] npm install -g grunt-cli

Install Node packages.

$ [sudo] npm install

Install GitHub Pages and runtime dependencies.

$ [sudo] grunt install

Local Deployment

Run the command below to preview a local instance of your site.

$ grunt serve

After Jekyll starts, fire up a browser and type in localhost:4000 for the web address. This will pull up the site Jekyll just generated.

Killing Jekyll

Serve mode lasts forever. It won't timeout after a period of non-usage. Press CTRL+C to stop the service.

Roll Your Own

Make a fresh clone and go into the directory.

$ git clone https://github.com/username/island.git
$ cd island

Create a new gh-pages branch.

$ git checkout --orphan gh-pages

Copy the contents from /canary to /island.

$ [sudo] cp -r ~/canary/* ~/island

Push your site to GitHub.

$ git add .
$ git commit -a -m "first commit"
$ git push origin gh-pages

Code Organization

Below is the basic spread for Canary (not including Jekyll or GitHub-related objects).

├─ _includes/
│   ├─ charts/
│   ├─ forms/
│   ├─ logs/
│   └─ modals/
│       ├─ processes/
│       └─ server/
├─ _layout/
├─ js/
├─ less/
├─ public/
│   ├─ css/
│   ├─ fonts/
│   ├─ img/
│   ├─ js/
│   └─ logs/
├─ alerts.html
├─ config.html
├─ index.html
├─ logs.html
├─ processes.html
├─ profile.html
├─ settings.html
├─ support.html
└─ usage.html

License

Code and documentation is licensed under the MIT license.