Flapjack JSONAPI documentation

The Flapjack JSONAPI lets you work with Flapjack data, including:

• Contacts
• Media
• PagerDuty credentials
• Notification Rules
• Entities
• Checks
• Reports

The flapjack-diner RubyGem provides a Ruby client library for Flapjack's JSONAPI.

The Flapjack JSONAPI documentation is built using Slate.

Developing

To edit the JSONAPI documentation:

git clone [email protected]:flapjack/slate.git
cd slate
bundle 
bundle exec middleman server

You can now see the docs at http://localhost:4567.

Building for flapjack.io

When you want to push updated documentation to flapjack.io, run:

rake build

The resulting documentation lives in the build/ directory.

From the gh-pages branch of your clone of flapjack/flapjack, run:

rake slate

And git commit the changes.

For more info on building documentation, check out the upstream documentation on building Slate documentation.