yjw9012 / docs

Documentation for Wavefront and its services

Wavefront Documentation

Install Required Software

1. Install Ruby if you don't have it already.
2. cd to the repository directory and run the following commands:

   $ cd docs
   $ sudo gem install bundler
   $ bundle install

3. Stay in the repository directory and clone the required submodules (which basically include the README.md of Wavefront public repositories into the official documentation)

   $ git submodule init
   $ git submodule fetch

Run and View Site Locally

1. Run Jekyll using the following command:

   $ bundle exec jekyll serve

2. Go to http://localhost:4000/. The host and port are set in _config.yml.