mirror of
https://github.com/inspec/inspec
synced 2024-12-11 22:02:47 +00:00
ba3ffc850d
it got much simpler this morning; this is 3am-safe now (unless you added garbage to the site, in which case there is nothing we can do... This automation protects you from human mistakes during the build and release process only).
52 lines
972 B
Markdown
52 lines
972 B
Markdown
# InSpec homepage
|
|
|
|
## Development
|
|
|
|
Get all dependencies:
|
|
|
|
```bash
|
|
bundle install
|
|
```
|
|
|
|
To run it live run:
|
|
|
|
```bash
|
|
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):
|
|
|
|
```bash
|
|
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, run this command:
|
|
|
|
```
|
|
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](http://localhost:8000).
|
|
|
|
If you are happy, you can confirm the site and let the release task push it live.
|