Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-14 00:47:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
inspec/www/README.md
Dominik Richter 275772050e
move /tutorial to /demo (#2700) 
* move /tutorial to /demo

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

* update netlify to build demo

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

* fix gulp run path

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

* ignore rubocop on www/demo

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2018-02-19 16:57:19 -08:00

1.4 KiB
Raw Blame History

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 demo, take a look at www/demo.

Building

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

bundle exec middleman build

To build everything including the online demo:

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