inspec/www/README.md
Adam Leff 65c95d243e Fixing www/docs rake tasks
This is a follow-up to #1585. The website-related Rake tasks have been
moved to a www-specific Rakefile which can be found in the www/
directory. Any web-release-related gems have been moved to the www
Gemfile as well.

This also included modifying the docs rake tasks to be path-
independent as they currently expect that Rake is being run from the
root of the repo.

Signed-off-by: Adam Leff <adam@leff.co>
2017-03-22 12:21:03 -04:00

1,018 B

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 www 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.