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
|
|
|
|
|
2016-09-26 10:05:16 +00:00
|
|
|
To build everything and push a new version of the website, run this command:
|
2016-09-22 19:26:19 +00:00
|
|
|
|
|
|
|
```
|
2016-09-26 10:05:16 +00:00
|
|
|
bundle exec rake www
|
2016-09-22 19:26:19 +00:00
|
|
|
```
|
|
|
|
|
2016-09-26 10:05:16 +00:00
|
|
|
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](http://localhost:8000).
|
|
|
|
|
|
|
|
If you are happy, you can confirm the site and let the release task push it live.
|