ROS Index

A simple static index for known ROS packages. It builds in jekyll with a plugin to clone repositories containing ROS packages, scrapes them for information, and uses client-side javascript for quick searching and visualization.

ROS Index

• About
• Design
• Development
• Contribute

Building

Pre-Requisites

Basic Ubuntu 12.04 Deps

sudo apt-get update
sudo apt-get install curl git git-svn mercurial nodejs pandoc

Ruby 2.2 via RVM

curl -L https://get.rvm.io | bash -s stable
# if this fails, add the PGP key and run again
source ~/.rvm/scripts/rvm
rvm requirements
rvm install ruby
rvm rubygems current

Node.js on Ubuntu 12.04

sudo apt-get install python-software-properties
sudo apt-add-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs

Ruby Requirements

gem install bundler

Clone Source and Install Gems

git clone git@github.com:rosindex/rosindex --recursive
cd rosindex.github.io
bundle install

Build the Devel (Tiny) Version

rake build:devel

Build the Deploy (Full) Version

Note: This requires a minimum of 30GB of free space for the _checkout directory.

rake build:devel

Skipping Parts of the Build

The build process entails four long-running steps:

1. Generating the list of repositories
2. Cloning / Updating the known repositories
3. Scraping the repositories
4. Generating the static pages
5. Generating the lunr search index

Each of the first three steps can be skipped in order to save time when experimenting with different parts of the pipeline with the following flags in _config.yml:

# If true, this skips finding repos based on the repo sources
skip_discover: false
# If true, this skips updating the known repos
skip_update: false
# If true, this skips scraping the cloned repos
skip_scrape: false
# If true, this skips generating the search index
skip_search_index: false

Deployment

Deployment is done by simply pushing the generated site to GitHub:

cd _deploy
git add .
git commit -a --amend
git push -f origin master