mirror of https://github.com/inspec/inspec synced 2024-11-23 13:13:22 +00:00

History

Franklin Webber 0274e02633 Adds additional tutorials created by Annie Hedgie Her work continues for a few more days. This adds those articles to the tutorials index. Signed-off-by: Franklin Webber <franklin@chef.io>		2016-12-08 10:46:34 -06:00
..
data	compensate for the intro page of docs	2016-09-26 06:21:05 +02:00
lib	introduce separate nav for docs in www/	2016-09-26 06:21:05 +02:00
source	Adds additional tutorials created by Annie Hedgie	2016-12-08 10:46:34 -06:00
tutorial	Adds junit to the inspec help exec	2016-11-30 01:17:44 -06:00
.gitignore	rake to render all docs to www/ correctly with links	2016-09-26 06:21:05 +02:00
config.rb	switch to redcarpet for rendering	2016-09-26 06:21:05 +02:00
config.ru	Fixup rubocop violation in www/	2016-09-13 15:11:48 +01:00
Gemfile	switch to redcarpet for rendering	2016-09-26 06:21:05 +02:00
Gemfile.lock	switch to redcarpet for rendering	2016-09-26 06:21:05 +02:00
README.md	update www readme for releasing the site	2016-09-26 12:05:25 +02:00

README.md

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, run this command:

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.