fa0a6c9794
* Sketch out contrib doc fetcher * Read contrib config file * Fetch contrib resource packs from git * Copy in resource pack docs from contrib * Task to cleanup copied-in files * Attach contrib resource pack docs fetching to main website doc generation * Refactor - rename vars in resource overview task for clarity * Generate resource overview page using info from contrib * Fix issue in which AWS and Azure resources were ending up under OS * Trigger contrib doc cleanup after doc build * Comment out the contrib.yaml for now * Disable contrib tasks if git is not available * Rubocop issues * Allow .md as doc file ending * Fix for files ending in md having a relative link * Omit 'resources' from section labels to save width * Rubocoooooooooooppppp Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> |
||
|---|---|---|
| .. | ||
| data | ||
| demo | ||
| lib | ||
| source | ||
| .gitignore | ||
| config.rb | ||
| config.ru | ||
| Gemfile | ||
| Rakefile | ||
| README.md | ||
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
- if you get an error building the css files it could be becuase you don't have node.js installed. e.g.
== Request: /stylesheets/vendor/fontawesome.min.css
== Finishing Request: stylesheets/vendor/fontawesome.min.css (0.0s)
error build/stylesheets/vendor/fontawesome.min.css
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_KEYFASTLY_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