inspec/www
hannah-radish 959f1e2ee0 HM website optimization (#2699)
* Font awesome

* Scroll to resources - done

* Overwriting swift type styles

* Fixed links

* Remove DL bin

* lint

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* lint

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* Add new breakpoints
2018-02-19 13:14:01 -08:00
..
data Update InSpec website (#2681) 2018-02-17 07:44:42 -08:00
lib Update InSpec website (#2681) 2018-02-17 07:44:42 -08:00
source HM website optimization (#2699) 2018-02-19 13:14:01 -08:00
tutorial HM website optimization (#2699) 2018-02-19 13:14:01 -08:00
.gitignore rake to render all docs to www/ correctly with links 2016-09-26 06:21:05 +02:00
config.rb Add with_toc_data option to markdown renderer (#2109) 2017-08-31 14:43:42 -04:00
config.ru Fixup rubocop violation in www/ 2016-09-13 15:11:48 +01:00
Gemfile Bump Rubocop to 0.49.1 (#2323) 2017-11-21 08:49:41 +01:00
Rakefile Bump Rubocop to 0.49.1 (#2323) 2017-11-21 08:49:41 +01:00
README.md Add instructions for building docs/ child pages (#2194) 2017-10-05 13:17:06 -04:00

InSpec homepage

Development

Get all dependencies:

bundle install

To build the docs/ child pages run:

bundle exec rake docs

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.

Flushing the Fastly Cache

The www Rake task will flush the cache at Fastly if you have the following environment variables set:

  • FASTLY_API_KEY
  • FASTLY_SERVICE_ID

These can be found in Chef's shared password manager. If these aren't set, the cache will not be flushed and will expire on its own. The cache can be flushed without doing a full website release by running rake www:flush