2016-09-21 16:16:09 +00:00
|
|
|
# InSpec homepage
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
Get all dependencies:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
bundle install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To run it live run:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
bundle exec middleman server
|
|
|
|
|
```
|
|
|
|
|
|
2016-09-23 09:29:22 +00:00
|
|
|
For the online tutorial, take a look at `www/tutorial`.
|
|
|
|
|
|
2016-09-21 16:16:09 +00:00
|
|
|
## Building
|
|
|
|
|
|
2016-09-23 09:29:22 +00:00
|
|
|
To build the site to a local static folder (without tutorial):
|
2016-09-21 16:16:09 +00:00
|
|
|
|
|
|
|
|
```bash
|
2016-09-22 19:26:19 +00:00
|
|
|
bundle exec middleman build
|
2016-09-21 16:16:09 +00:00
|
|
|
```
|
2016-09-22 19:26:19 +00:00
|
|
|
|
2016-09-23 09:29:22 +00:00
|
|
|
To build everything including the online tutorial:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
bundle exec rake www:build
|
|
|
|
|
```
|
|
|
|
|
|
2016-09-22 19:26:19 +00:00
|
|
|
## Releasing
|
|
|
|
|
|
|
|
|
|
To push a new version of the website, make sure that you have built the site
|
|
|
|
|
(see previous section) and that you are happy with the results. If so, run:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
bundle exec rake www:release
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
It will clear and create a local `gh-pages` branch, add the site to it,
|
|
|
|
|
and ask you before it pushes everything to `origin/gh-pages` i.e. the live
|
|
|
|
|
website.
|
