Documentation site for Datadog

Built with nanoc, a static website generation tool.

Pre-requisites

• Ruby
• RubyGems
• Bundler

Getting started

Install the dependencies with bundler. I like to install them under the project root:

$ bundle install --path vendor/bundle

Once the deps are installed, you should be able to accomplish what you need to with the included Rake tasks.

Doing stuff

Compile the static site:

$ bundle exec rake compile

Run a local webserver to view the compiled site:

$ bundle exec rake view

Run a local webserver and auto-update:

$ bundle exec rake autocompile

I recommend disabling the syntax highlighting if you run the server with autocompile since it's slow. In Rules:

    filter :erb
    filter :kramdown
#    filter :colorize_syntax,
#      :colorizers => {:javascript => :pygmentize}
    layout 'default'

Deploy the static site

In order for this to work, you need to have the static site repo checked out next to this one (i.e. from the root of this repo, the static site should be located at ../datadog.github.com/):

$ git clone [email protected]:DataDog/datadog.github.com.git

Then run the release Rake task, which should do a clean compile of the site and then copy all the new files over to the static repo and create a new commit. WARNING! This task will wipe out any uncommitted changes in the static repo.

$ bundle exec rake release