jaywengrow / cylon-site Goto Github PK

This is the code for the website for Cylon (http://cylonjs.com) is a JavaScript framework for robotics, physical computing, and the Internet of Things using Node.js. If you are looking for the actual Cylon code itself, it is at https://github.com/hybridgroup/cylon

This site is build using Middleman

To run locally:

  bundle install
  bundle exec middleman

middleman-gh-pages gem is being used to build the webpage and deploy to gh-pages branch.

For deploying the webpage, your must be in 'master' branch and run the following command:

  rake publish

You must not have any uncomitted or untracked files in the site dirs, or the publish operation will fail with a message such as Directory not clean.

If the publish fails, you might need to remove the build dir before trying to run rake publish again.

This project uses HAML.

If you want to help us with the documentation of the site, you can follow this steps :

• 1. Download the zip of the branch "master" or clone the project with git.

      git clone [email protected]:hybridgroup/cylon-site.git "name"
     

• 2. Create a new branch for the project and switch to that new branch.

      git branch "new_name"
      git checkout "new_name"
     

  or

  git checkout -b "new_name"
  

• 3. Open the project with your favourite text editor.
• 4. Go to the file source/documentation , here is all the documentation of the site.

To add new information to any platform, do this :

• 1. Go to the file source/documentation/platforms , and select the platform you want to edit.

To add new information to any driver, do this :

• 1. Go to the file source/documentation/drivers , and select the driver you want to edit.

To import examples from the main Cylon repository, run the bin/import_examples script. You'll need to have Git installed.

This script will:

• clone down the Cylon repo
• extract all examples
• create missing example pages and remove those that have also been removed from the main repo
• create/update examples index page

To import docs partials from Cylon adaptor repositories, run the bin/import_repo_docs script.

This script will:

• clone down Cylon adaptor repositories
• extract all docs/*.md documents
• add them as partials to source/documentation/drivers/partials

If you want to only import docs from a single repo:

bin/import_repo_docs hybridgroup/cylon-gpio

or

bin/import_repo_docs https://github.com/hybridgroup/cylon-gpio.git

When you have your code ready, create a new PR : base: master and compare:"your_branch"