Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-10 07:04:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update documentation release process instructions

Browse source 
Signed-off-by: IanMadd <imaddaus@chef.io>
This commit is contained in:
IanMadd 2020-07-09 10:06:12 -07:00
parent 3ef1bd9b2e
commit 2c50f907f3
2 changed files with 4 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
RELEASE_PROCESS.md
View file

@ -165,15 +165,7 @@ Among other things, this promotion automatically generates [release notes](https
The release of InSpec will automatically create a PR to bump InSpec in https://github.com/chef/homebrew-chef
This should be merged - at some point this could be changed to directly committing to the repo.
## Updating inspec.io
If the release included changes to docs pages, then publish the current docs to inspec.io.
1. In your bash profile, have values exported for FASTLY_SERVICE_ID and FASTLY_API_KEY (ask Chef Helpdesk if you don't have these).
2. Make sure nodejs is installed (e.g. `brew install nodejs`)
2. Checkout `master` and `git pull` to ensure you have the latest code. Also ensure you have the `gh-pages` branch fetched.
3. `cd www`
4. `bundle install` to install the www directory's gem bundle. Depending on your Ruby setup you may need to use the `--gemfile=Gemfile` option to stop bundler from installing the root gem set.
5. Run `bundle exec rake www PUSH=1` to do a complete build, push, publish and cache clear of the website.
6. Check http://www.inspec.io for expected changes. Fastly will clear cache after about 30 seconds.
## Updating InSpec Docs on docs.chef.io
See the [README](https://github.com/inspec/inspec/blob/master/www/README.md#update-the-inspec-repository-module-in-chefchef-web-docs) for instructions on
updating the current InSpec documentation on docs.chef.io.

2
www/README.md
View file

@ -64,7 +64,7 @@ Or, for the adventurous:
1. Make sure your documentation changes are merged into master in `inspec/inspec`.
1. On a local clone of `chef/chef-web-docs` run:
1. `hugo mod get github/com/inspec/inspec/www`
1. `hugo mod get github.com/inspec/inspec/www`
1. `hugo mod tidy`
1. `hugo mod vendor`
1. Submit a pull request to `chef/chef-web-docs`.