hybridgroup / gobot-site

Website for Gobot - Golang framework/set of libraries for robotics and physical computing

Gobot Website

This is the code for the website for Gobot (http://gobot.io) a framework for robotics, drones, and the Internet of Things (IoT) written using the Go programming language (http://golang.org/)

If you are looking for the actual Gobot code itself, it is at https://github.com/hybridgroup/gobot

This site is built using Middleman

To run locally:

  bundle install
  bundle exec middleman

Documentation

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/gobot-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 , which has all the documentation of the site.

Platforms

All of the page content is generated from the platform's github repo. To add new documentation to any platform, edit the readme in the respective Gobot module's repository.

In order for the readme to be properly extracted, the content being pushed to the site must:

• include a ## How to Install section following the platform introduction
• have a new line after each code block

To import platforms from the main Gobot repository, run the bin/import_platforms script. You'll need to have Git installed.

This script will:

• clone down the Gobot repos
• extract all platform readmes
• convert github markdown syntax to be haml compatible
• save the platform documentation to source/documentation/platforms/partials

Drivers

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.

Examples

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

This script will:

• clone down the Gobot 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

Repo Docs

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

This script will:

• clone down Gobot 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/gobot-gpio

or

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

Images

To add images for platforms or devices:

• remove entire background
• the image should be 800 width x 600 height
• layer effect: White color overlay with blend mode HUE

Background color is #F3F1EB

To replace background color using GIMP:

https://www.gimp.org/tutorials/Changing_Background_Color_1/

Send your Pull Request

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

Deploy

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.

gobot-site's Issues

Add docs for using Gobot "bare metal"

We need to add some docs that show how to use Gobot as a library, without using the entire framework, as discussed over in hybridgroup/gobot#302

Spark Core imcompatible to Servo

There is an issue open on the gobot repo from december 2014.
While not working, the spark core should not be listed to be compatible with the servo.

Link is broken

The link to http://www.cppp.io/ on the home page isn't working.

Improve Getting Started docs

It would be very nice to be able to have some explanation of the major features and architectural components/abstractions right off the bat. I'm creating this issue as a discussion venue for some improvements in that area.

Remove 'easy' and 'simple'

Remove the words "easy" and "simple" from docs to avoid discouraging beginners.

Broken link for chat

https://gobot.io/documentation/getting-started/

at the botton
....or ping us on IRC. (https://gobot.io/documentation/chat/)

Raspberry pi cannot be supported for analog

https://gobot.io/documentation/drivers/analog-sensor/

It says below that the raspberry pi is supported but the pi has no analog pins?

Convert site to Hugo

I'm very interested in converting the site generation code from Middleman to Hugo. Anyone want to help with this? :)

Syntax error in example on landing page

The example for The "Hello, World" Of Things contains a syntax error.

Corresponding file: source/index.html.haml

Trying to build the example results in:

./main.go:21: undefined: robot
./main.go:27: undefined: robot in robot.Start

robot needs to be declared. It is fixed by changing = to :=