Permalink
Browse files

Updated jekylll stuff per instructions here: https://help.github.com/…

  • Loading branch information...
treeder committed Jan 27, 2014
1 parent 097d868 commit fad3006bfdd09205b7450b9ab0f2f1d85644f767
Showing with 76 additions and 16 deletions.
  1. +3 −0 Gemfile
  2. +62 −0 Gemfile.lock
  3. +6 −9 README.md
  4. +0 −1 _config.yml
  5. +0 −1 _includes/nav.html
  6. +5 −5 cache/reference/api/index.md
View
@@ -0,0 +1,3 @@
source 'https://rubygems.org'
gem 'github-pages'
View
@@ -0,0 +1,62 @@
GEM
remote: https://rubygems.org/
specs:
RedCloth (4.2.9)
blankslate (2.1.2.4)
classifier (1.3.4)
fast-stemmer (>= 1.0.0)
colorator (0.1)
commander (4.1.5)
highline (~> 1.6.11)
fast-stemmer (1.0.2)
ffi (1.9.3)
github-pages (14)
RedCloth (= 4.2.9)
jekyll (= 1.4.3)
kramdown (= 1.3.1)
liquid (= 2.5.5)
maruku (= 0.7.0)
rdiscount (= 2.1.7)
redcarpet (= 2.3.0)
highline (1.6.20)
jekyll (1.4.3)
classifier (~> 1.3)
colorator (~> 0.1)
commander (~> 4.1.3)
liquid (~> 2.5.5)
listen (~> 1.3)
maruku (~> 0.7.0)
pygments.rb (~> 0.5.0)
redcarpet (~> 2.3.0)
safe_yaml (~> 0.9.7)
toml (~> 0.1.0)
kramdown (1.3.1)
liquid (2.5.5)
listen (1.3.1)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
rb-kqueue (>= 0.2)
maruku (0.7.0)
parslet (1.5.0)
blankslate (~> 2.0)
posix-spawn (0.3.8)
pygments.rb (0.5.4)
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.1.0)
rb-fsevent (0.9.4)
rb-inotify (0.9.3)
ffi (>= 0.5.0)
rb-kqueue (0.2.0)
ffi (>= 0.5.0)
rdiscount (2.1.7)
redcarpet (2.3.0)
safe_yaml (0.9.7)
toml (0.1.0)
parslet (~> 1.5.0)
yajl-ruby (1.1.0)
PLATFORMS
ruby
DEPENDENCIES
github-pages
View
@@ -1,20 +1,17 @@
# Installation
1. Jekyll requires Pygments so:
* `sudo apt-get install python-setuptools`
* `sudo easy_install pygments`
2. Install jekyll gem: `sudo gem install jekyll`
3. clone this repo.
Detailed instructions for different environments: https://github.com/mojombo/jekyll/wiki/install
1. run `bundle install`
# Launching
1. Go to project directory
2. Type `jekyll` # do not use --auto! jekyll breaks
3. Open browser at `http://localhost:4000/`
2. Type `bundle exec jekyll serve` # do not use --auto! jekyll breaks
3. Open browser at http://localhost:4000/
# Development
1. go to project directory
2. jekyll serve --watch (this will auto reload any changes)
3. for more information on jekyll http://jekyllrb.com/docs/home/
More info: https://help.github.com/articles/using-jekyll-with-pages
View
@@ -1,5 +1,4 @@
permalink: /:title
server: true
domain: "dev.iron.io"
google_cse_id: 012672112220120861281:u1mwwky5lri
pygments: true
View
@@ -7,6 +7,5 @@
<li class="active"><a href="http://dev.iron.io">Dev Center</a></li>
<li class=""><a href="http://blog.iron.io">Blog</a></li>
<li class=""><a href="http://hud.iron.io">Login</a></li>
</li>
</ul>
</nav>
@@ -28,7 +28,7 @@ IronCache provides a REST/HTTP API to allow you to interact programmatically wit
<li><a href="#exponential_backoff">Exponential Backoff</a></li>
</ul>
</li>
</ul>
</ul>
</section>
## Endpoints
@@ -54,10 +54,10 @@ IronCache uses OAuth2 tokens to authenticate API requests. All methods require a
Note that each request also requires a Project ID to specify which project the action will be performed on. You can find your Project IDs [in the HUD](https://hud.iron.io). Project IDs are also universal, so they can be used across services as well.
**Example Authorization Header**:
**Example Authorization Header**:
Authorization: OAuth abc4c7c627376858
**Example Query with Parameters**:
**Example Query with Parameters**:
GET https://cache-aws-us-east-1.iron.io/1/projects/<span class="variable project_id">{Project ID}</span>/caches?oauth=abc4c7c627376858
Notes:
@@ -93,7 +93,7 @@ The domains for the clouds IronCache supports are as follows:
For endpoints that return lists/arrays of values:
* page - The page of results to return. Default is 0. Maximum is 100.
* per_page - The number of results to return. It may be less if there aren't enough results. Default is 30. Maximum is 100.
* per_page - The number of results to return. It may be less if there aren't enough results. Default is 30. Maximum is 100.
## Responses
@@ -104,7 +104,7 @@ All responses are in JSON, with Content-Type of `application/json`. A response i
{% endhighlight %}
### Status Codes
The success or failure of a request is indicated by an HTTP status code. A 2xx status code indicates success, whereas a 4xx or 5xx status code indicates an error.
The success or failure of a request is indicated by an HTTP status code. A 2xx status code indicates success, whereas a 4xx or 5xx status code indicates an error.
<table class="reference">
<thead>

0 comments on commit fad3006

Please sign in to comment.