Iron.io Dev Center documentation.
CSS HTML JavaScript Ruby Shell
Latest commit 52db6af Sep 21, 2016 @treeder treeder Updated README.
Permalink
Failed to load latest commit information.
.bundle Fixed spelling errors, etc. Sep 21, 2016
_includes Fixed spelling errors, etc. Sep 21, 2016
_layouts add intercom-acquire, modify sidebar options Jun 12, 2015
_plugins Fixed spelling errors, etc. Sep 21, 2016
_posts Remove hipchat, add slack Jun 11, 2015
articles baseurl May 13, 2013
cache Added new node lib Oct 11, 2015
community Remove hipchat, add slack Jun 11, 2015
css new page for custom docker images Dec 17, 2015
faq Updated link on faq page Nov 3, 2015
images upload Aug 10, 2016
jpkImages creation Jun 24, 2016
js add intercom-acquire, modify sidebar options Jun 12, 2015
mq Fix typos. Aug 19, 2016
partner_docs More cleanup. Sep 9, 2015
search include the plugin for using the lunr.js tool Jul 10, 2014
solutions clarification of page titles Dec 19, 2014
support left a line in Apr 4, 2016
worker Added more pages to on prem. Sep 21, 2016
.gitignore new page for custom docker images Dec 17, 2015
404.html fix spacing, no real changes Jul 15, 2013
CNAME cname change Mar 1, 2012
Dockerfile Fixed spelling errors, etc. Sep 21, 2016
Gemfile Fixed spelling errors, etc. Sep 21, 2016
Gemfile.lock Fixed spelling errors, etc. Sep 21, 2016
README.md Updated README. Sep 21, 2016
_config.yml changed syntax highlighter from pygments to rouge Jun 10, 2016
favicon.ico Add favicon. Feb 26, 2012
humans.txt force deploy, modify humans Apr 1, 2014
index.html fixed link in mq button to go to v3 Dec 14, 2015
open-search.xml Enabled open search integration Mar 1, 2012
search.json update links for Search page Apr 17, 2015

README.md

Iron.io Dev Center Documentation

The Dev Center docs are a Jekyll project. Refer to Jekyll's official docs and Using Jekyll with GitHub Pages for complete help. We give a quick start guide below.

Installation

  1. Get Bundler, the Ruby dependency manager, if you don't have it already.
  2. $ git clone https://github.com/iron-io/docs.git && cd docs
  3. $ bundle install

Launching

  1. In the project directory, run bundle exec jekyll serve
  2. Open your browser to http://localhost:4000/

Contributing

In the project directory, run bundle exec jekyll serve --watch. This will auto-reload as you make changes to files. TODO: not sure if --watch is required anymore?

Please submit all changes as Pull Requests.

Try not to use HTML unless it's required! Use markdown for everything if possible.

Using Docker to avoid the pain of installing things like nokogiri

  1. docker build -t jekyll .
  2. docker run --rm -it -v "$PWD":/app -p 4000:4000 jekyll serve --watch --host 0.0.0.0

Note: to do a bundle update, run docker run --rm -it -v "$PWD":/app -w /app iron/ruby:dev bundle update