Merge pull request #18 from cloudops/cmc-dev

V1 of CloudMC doc

Author: pdube

README.md

@@ -1,50 +1,24 @@
-<p align="center">
-  <img src="https://raw.githubusercontent.com/lord/img/master/logo-slate.png" alt="Slate: API Documentation Generator" width="226">
-  <br>
-  <a href="https://travis-ci.org/lord/slate"><img src="https://travis-ci.org/lord/slate.svg?branch=master" alt="Build Status"></a>
-</p>
 
-<p align="center">Slate helps you create beautiful, intelligent, responsive API documentation.</p>
-
-<p align="center"><img src="https://raw.githubusercontent.com/lord/img/master/screenshot-slate.png" width=700 alt="Screenshot of Example Documentation created with Slate"></p>
-
-<p align="center"><em>The example above was created with Slate. Check it out at <a href="https://lord.github.io/slate">lord.github.io/slate</a>.</em></p>
-
-Features
+CloudMC API documentation
 ------------
 
-* **Clean, intuitive design** — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [Paypal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even in print.
-
-* **Everything on a single page** — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.
-
-* **Slate is just Markdown** — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks.
-
-* **Write code samples in multiple languages** — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown.
+This repository contains the CloudMC API documentation
 
-* **Out-of-the-box syntax highlighting** for [over 100 languages](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers), no configuration required.
-
-* **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.
-
-* **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere.
-
-Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://lord.github.io/slate).
-
-Getting Started with Slate
+Writing new documentation
 ------------------------------
 
 ### Prerequisites
 
 You're going to need:
 
  - **Linux or OS X** — Windows may work, but is unsupported.
- - **Ruby, version 2.3.1 or newer**
+ - **Ruby, version 2.2.5 or newer**
  - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.
 
 ### Getting Set Up
 
-1. Fork this repository on Github.
-2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git`
-3. `cd slate`
+1. Clone this repository
+2. `cd slate`
 4. Initialize and start Slate. You can either do this locally, or with Vagrant:
 
 ```shell
@@ -58,57 +32,6 @@ vagrant up
 
 You can now see the docs at http://localhost:4567. Whoa! That was fast!
 
-Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/lord/slate/wiki/Deploying-Slate).
+Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax)
 
 If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker).
-
-### Note on JavaScript Runtime
-
-For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the [rubyracer gem](https://github.com/cowboyd/therubyracer) to your gemfile and run `bundle` again.
-
-Companies Using Slate
----------------------------------
-
-* [NASA](https://api.nasa.gov)
-* [IBM](https://docs.cloudant.com/api.html)
-* [Sony](http://developers.cimediacloud.com)
-* [Best Buy](https://bestbuyapis.github.io/api-documentation/)
-* [Travis-CI](https://docs.travis-ci.com/api/)
-* [Greenhouse](https://developers.greenhouse.io/harvest.html)
-* [Woocommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/)
-* [Appium](http://appium.io/slate/en/master)
-* [Dwolla](https://docs.dwolla.com/)
-* [Clearbit](https://clearbit.com/docs)
-* [Coinbase](https://developers.coinbase.com/api)
-* [Parrot Drones](http://developer.parrot.com/docs/bebop/)
-* [Fidor Bank](http://docs.fidor.de/)
-* [Scale](https://docs.scaleapi.com/)
-
-You can view more in [the list on the wiki](https://github.com/lord/slate/wiki/Slate-in-the-Wild).
-
-Need Help? Found a bug?
---------------------
-
-[Submit an issue](https://github.com/lord/slate/issues) to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes.
-
-Contributors
---------------------
-
-Slate was built by [Robert Lord](https://lord.io) while interning at [TripIt](https://www.tripit.com/).
-
-Thanks to the following people who have submitted major pull requests:
-
-- [@chrissrogers](https://github.com/chrissrogers)
-- [@bootstraponline](https://github.com/bootstraponline)
-- [@realityking](https://github.com/realityking)
-- [@cvkef](https://github.com/cvkef)
-
-Also, thanks to [Sauce Labs](http://saucelabs.com) for sponsoring the development of the responsive styles.
-
-Special Thanks
---------------------
-- [Middleman](https://github.com/middleman/middleman)
-- [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js)
-- [middleman-syntax](https://github.com/middleman/middleman-syntax)
-- [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages)
-- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)

lib/toc_data.rb

@@ -5,7 +5,7 @@ def toc_data(page_content)
 
   # get a flat list of headers
   headers = []
-  html_doc.css('h1, h2, h3').each do |header|
+  html_doc.css('h1, h2, h3, h4').each do |header|
     headers.push({
       id: header.attribute('id').to_s,
       content: header.children,
@@ -14,7 +14,7 @@ def toc_data(page_content)
     })
   end
 
-  [3,2].each do |header_level|
+  [4,3,2].each do |header_level|
     header_to_nest = nil
     headers = headers.reject do |header|
       if header[:level] == header_level

source/images/favicon.png

@@ -1,4 +1,4 @@
-# Administration API
+# Administration
 
 The following sections describe the various endpoints exposed by CloudMC to manage customer's configuration and interact with various core functionality of the system. Using these, you can automate various workflows without having to log into the portal, or simply integrate different aspects of CloudMC with your own toolchain.
 <aside class="notice">

source/images/logo.png

@@ -1,10 +1,8 @@
-# CloudStack API
+# CloudStack plugin
 
-The CloudStack API provides endpoints for carrying out operations on CloudMC compute and networking entities. While each operation has its own validation and required fields, all operations need to specify the service code and environment in which they should be carried out. The following example URL describes how to specify this information for all entities.
+The CloudStack plugin provides endpoints for carrying out operations on CloudMC compute and networking entities. While each operation has its own validation and required fields, all operations need to specify the service code and environment in which they should be carried out. The following example URL describes how to specify this information for all entities.
 
-<code>https://cloudmc_endpoint/v1/services/<a href="#service-connections">:service_code</a>/<a href="#environments">:environment_name</a>/:entity_type</code>
-
-The two CloudStack service codes currently available in CloudMC correspond to compute regions: `compute-qc` for Québec, and `compute-on` for Ontario.
+<code>https://cloudmc_endpoint/v1/services/<a href="#administration-service-connections">:service_code</a>/<a href="#administration-environments">:environment_name</a>/:entity_type</code>
 
 <aside class="notice">
 An easy way to remember the structure of API endpoints is that going from left to right, the scope gets progressively more specific. First service, then environment of that service, then entity type, then operation on that entity type, etc.

source/includes/_administration.md

@@ -6,27 +6,15 @@ The API is  [RESTful](https://en.wikipedia.org/wiki/Representational_state_trans
 
 API endpoint : `https://cloudmc_endpoint/v1`
 
-<!-- We have also developed tools to help consume our APIs. If you use `go`, check out our [library](https://github.com/cloud-ca/go-cloudca). If you use Terraform, check out our [provider](https://github.com/cloud-ca/terraform-cloudca). NB: both are being actively developed, so there is still some functionality missing.
- -->
 ## Authentication
-<!-- ```go
-import "github.com/cloud-ca/go-cloudca"
-ccaClient := cca.NewCcaClient("your_api_key")
-```
- -->
+
 ```shell
 ## To authenticate, add a header
 ## Make sure to replace `your_api_key` with your API key.
 curl "https://cloudmc_endpoint/v1/organizations" \
    -H "MC-Api-Key: your_api_key"
 ```
 
-<!-- ```dart
-provider "cloudca" {
-    api_key = "${var.my_api_key}"
-}
-``` -->
-
 API endpoints are secured by the same role-based access control (RBAC) as the CloudMC portal. To identify who is making the requests, it is required to add a header to your HTTP requests:
 
 `MC-Api-Key: your_api_key`
@@ -91,8 +79,8 @@ When an API request is successful, the response body will contain the `data` fie
 Attributes | &nbsp;
 --- | ---
 `data` | The data field contains the object requested by the API caller
-`taskId` | The [task id](#tasks) of an operation executed through the [compute API](#compute-api)
-`taskStatus` | The status of a [task](#tasks) of an operation executed through the [compute API](#compute-api)
+`taskId` | The [task id](#tasks) of an operation executed through the services API
+`taskStatus` | The status of a [task](#tasks) of an operation executed the services API
 <!--
 `metadata` | The metadata is an optionally returned field containing paging and sorting information
 -->
@@ -121,22 +109,6 @@ If the response contains the "errors" field, the request was <strong>not</strong
   ]
 }
 ```
-```go
-_, err := ccaResources.Volumes.Get("[some-volume-id]")
-if err != nil {
-   if errorResponse, ok := err.(api.CcaErrorResponse); ok {
-      if errorResponse.StatusCode == api.NOT_FOUND {
-         fmt.Println("Volume was not found")
-      } else {
-         //Can get more details from the CcaErrors
-         fmt.Println(errorResponse.Errors)
-      }
-   } else {
-      //handle unexpected error
-      panic("Unexpected error")
-   }
-}
-```
 
 When an API request is unsuccessful, the response body will contain the `errors` field :
 

source/includes/_cloudstack.md

@@ -0,0 +1,3 @@
+# OpenStack plugin
+
+The CloudMC OpenStack plugin incorporates various OpenStack services such as Nova and Neutron into CloudMC's API. It also enforces CloudMC's environment-centric multi-tenancy model and RBAC over top of OpenStack.