inspec/www
Adam Leff a1b7e3167e [www] Adding a website acceptance environment
If changes are detected in the docs or www directory, a website
build will be generated that pushes up to Netlify. This will allow
teams to validate web changes without requiring pulling down the
branch and building locally.

Signed-off-by: Adam Leff <adam@leff.co>
2017-04-12 10:10:36 -04:00
..
data Add docs for habitat CLI commands 2017-03-28 13:59:38 -04:00
lib Address rubocop violations 2017-02-08 16:49:16 -06:00
source Add warning to the http resource documentation 2017-04-03 17:21:15 -04: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 Fixing www/docs rake tasks 2017-03-22 12:21:03 -04:00
Gemfile.lock [www] Adding a website acceptance environment 2017-04-12 10:10:36 -04:00
Rakefile [www] Adding a website acceptance environment 2017-04-12 10:10:36 -04:00
README.md Fixing www/docs rake tasks 2017-03-22 12:21:03 -04: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 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.