inspec/www
Adam Leff 199cb160ea Move simulator gems to www
The simulator gems are not necessary for building InSpec, only the website.
This is currently causing issues in the Jenkins infrastructure due to
a downstream dependency of github-markup.

Signed-off-by: Adam Leff <adam@leff.co>
2017-03-21 16:11:56 -04:00
..
data Cross-browser support for Moz, safari, google 2017-01-20 10:26:47 +01:00
lib Address rubocop violations 2017-02-08 16:49:16 -06:00
source Hide Event Feature on Homepage 2017-03-14 13:22:24 -07:00
tutorial Address rubocop violations 2017-02-08 16:49:16 -06:00
.gitignore rake to render all docs to www/ correctly with links 2016-09-26 06:21:05 +02:00
config.rb introducing a specific docs layout for all docs pages 2017-01-20 10:28:38 +01:00
config.ru Fixup rubocop violation in www/ 2016-09-13 15:11:48 +01:00
Gemfile Move simulator gems to www 2017-03-21 16:11:56 -04:00
Gemfile.lock switch to redcarpet for rendering 2016-09-26 06:21:05 +02:00
README.md Clarify instructions on releasing inspec.io 2016-12-22 13:52:50 +01:00

InSpec homepage

Development

Get all dependencies:

bundle install

To run it live run:

bundle exec middleman server

For the online tutorial, take a look at www/tutorial.

Building

To build the site to a local static folder (without tutorial):

bundle exec middleman build

To build everything including the online tutorial:

bundle exec rake www:build

Releasing

To build everything and push a new version of the website, be in the root folder of this repository and run:

bundle install
bundle exec rake www

It will clear everything and build from scratch and create a local gh-pages branch with a static version of the website. Before pushing, it will ask you if you are happy with it.

Please verify the site now! To host the current folder you can run:

ruby -run -e httpd . -p 8000

Open your browser to localhost:8000.

If you are happy, you can confirm the site and let the release task push it live.