This site is based on Jekyll, with a dash of Twitter Bootstrap added.
Requirements
Installing Jekyll is easy and straight-forward, but there are a few requirements you’ll need to make sure your system has before you start.
- Ruby (including development headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3)
- RubyGems
- Linux, Unix, or macOS
- NodeJS, or another JavaScript runtime (Jekyll 2 and earlier, for CoffeeScript support).
- Python 2.7 (for Jekyll 2 and earlier)
The master branch is continuously deployed to production.
Please, feel free to make any contributions you feel will make Cloud Elements Documentation better.
Submit all pull requests to the master branch
$ git clone [email protected]:cloud-elements/devportal.git
$ cd devportal
$ sudo gem install jekyll redcarpet jekyll-sitemap jekyll-redirect-from jekyll-youtube$ jekyll serveNow browse to http://127.0.0.1:4000/ and code away!
Element Docs will be placed in their respective folder, e.g. Salesforce. The Element Docs are structured in the following way:
|-- root
|-- docs
|-- elements
|-- element folder (e.g. Salesforce)
|-- element specific docs (e.g. endpoint setup, create instance)Platform docs like Hub level documentation, Events Framework, and OAuth Proxy are located at the docs -- platform level:
|-- root
|-- docs
|-- platform
|-- event-management
|-- event-management specific docs (e.g. how to guides, videos)Product docs like Element Builder, Mapper, Groud2Cloud, Formulas are located at the docs -- products level:
|-- root
|-- docs
|-- products
|-- element-builder
|-- element-builder specific docs (e.g. how to guides, videos)Quick Start docs like authentication and FAQs are located at the docs -- getstarted level:
|-- root
|-- docs
|-- getstarted
|-- authenticationAll documents are composed in markdown. HTML can be used right in the markdown docs.
You can write pages in markdown, HTML, or HAML. They all get converted to HTML when the site is generated.
The site uses the Redcarpet Markdown Syntax View Cheatsheet
Pages have a block of YAML at the top that sets a few options. They are pretty self explanatory; here's an example of an Element YAML:
---
heading: Salesforce CRM
seo: Overview | Salesforce CRM | Cloud Elements API Docs
title: Overview
description: Integrate Salesforce CRM into your application via the Cloud Elements APIs.
layout: docs
breadcrumbs: /docs/elements.html
elementId: 23
parent: Back to Element Guides
order: 1
sitemap: false
---
here's an example of a Product YAML:
---
heading: Instance APIs
seo: Instance APIs Overview | Cloud Elements API Docs
title: Overview
description: Find API documentation and example API calls.
layout: docs
platform: instances
breadcrumbs: /docs/platform/platform-docs.html
parent: Back to Platform Docs
order: 1
sitemap: false
---
(The MIT License)
Copyright © 2012-2016 Cloud Elements Inc http://cloud-elements.com/.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.