mirror of
https://github.com/inspec/inspec
synced 2024-11-10 07:04:15 +00:00
Update various readmes and docs
Signed-off-by: IanMadd <imaddaus@chef.io>
This commit is contained in:
parent
5eca8a2ad3
commit
6a592a6db2
11 changed files with 30 additions and 27 deletions
|
@ -25,13 +25,13 @@ We have a 3 step process for contributions:
|
|||
|
||||
Chef Projects are built to last. We strive to ensure high quality throughout the experience. In order to ensure this, we require that all pull requests to Chef projects meet these specifications:
|
||||
|
||||
1. **Tests:** To ensure high quality code and protect against future regressions, we require all the code in Chef Projects to have at least unit test coverage. See the [test/unit](https://github.com/chef/inspec/tree/master/test/unit)
|
||||
1. **Tests:** To ensure high quality code and protect against future regressions, we require all the code in Chef Projects to have at least unit test coverage. See the [test/unit](https://github.com/inspec/inspec/tree/master/test/unit)
|
||||
directory for the existing tests and use ```bundle exec rake test``` to run them.
|
||||
2. **Green CI Tests:** We use [Travis CI](https://travis-ci.org/) and/or [AppVeyor](https://www.appveyor.com/) CI systems to test all pull requests. We require these test runs to succeed on every pull request before being merged.
|
||||
3. **Up-to-date Documentation:** Every code change should be reflected in an update for our [documentation](https://github.com/chef/inspec/tree/master/docs). We expect PRs to update the documentation with the code change.
|
||||
3. **Up-to-date Documentation:** Every code change should be reflected in an update for our [documentation](https://github.com/inspec/inspec/tree/master/docs-chef-io). We expect PRs to update the documentation with the code change.
|
||||
|
||||
In addition to this it would be nice to include the description of the problem you are solving
|
||||
with your change. You can use [Issue Template](https://github.com/chef/inspec/tree/master/ISSUE_TEMPLATE.md) in the description section
|
||||
with your change. You can use [Issue Template](https://github.com/inspec/inspec/tree/master/ISSUE_TEMPLATE.md) in the description section
|
||||
of the pull request.
|
||||
|
||||
### Code Review Process
|
||||
|
@ -163,6 +163,6 @@ InSpec is made possible by a strong community of developers, system administrato
|
|||
|
||||
Also here are some additional pointers to some awesome Chef content:
|
||||
|
||||
- [InSpec Docs](https://www.inspec.io/docs/)
|
||||
- [InSpec Docs](https://docs/chef.io/inspec/)
|
||||
- [Learn Chef](https://learn.chef.io/)
|
||||
- [Chef Website](https://www.chef.io/)
|
||||
|
|
14
README.md
14
README.md
|
@ -24,7 +24,7 @@ describe inetd_conf do
|
|||
end
|
||||
```
|
||||
|
||||
Chef InSpec makes it easy to run your tests wherever you need. More options are found in our [CLI docs](https://www.inspec.io/docs/reference/cli/).
|
||||
Chef InSpec makes it easy to run your tests wherever you need. More options are found in our [CLI docs](https://docs.chef.io/inspec/cli/).
|
||||
|
||||
```bash
|
||||
# run test locally
|
||||
|
@ -339,17 +339,17 @@ In addition, runtime support is provided for:
|
|||
|
||||
Documentation
|
||||
|
||||
* https://www.inspec.io/docs/
|
||||
* https://www.inspec.io/docs/reference/resources/
|
||||
* https://github.com/chef/inspec/tree/master/docs
|
||||
* https://docs.chef.io/inspec/
|
||||
* https://docs.chef.io/inspec/resources/
|
||||
* https://github.com/inspec/inspec/tree/master/docs-chef-io
|
||||
|
||||
Tutorials/Blogs/Podcasts:
|
||||
Learn Chef:
|
||||
|
||||
* https://www.inspec.io/tutorials/
|
||||
* https://community.chef.io/products/chef-inspec/#learn
|
||||
|
||||
Relationship to other tools (RSpec, Serverspec):
|
||||
|
||||
* https://www.inspec.io/docs/reference/inspec_and_friends/
|
||||
* https://docs.chef.io/inspec/inspec_and_friends/
|
||||
|
||||
## Share your Profiles
|
||||
|
||||
|
|
|
@ -177,5 +177,5 @@ This should be merged - at some point this could be changed to directly committi
|
|||
|
||||
## 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
|
||||
See the [README](https://github.com/inspec/inspec/blob/master/docs-chef-io/README.md#update-the-inspec-repository-module-in-chefchef-web-docs) for instructions on
|
||||
updating the current InSpec documentation on docs.chef.io.
|
||||
|
|
|
@ -70,7 +70,7 @@ Putting this all together, here is a plugins.json file from the Chef InSpec test
|
|||
|
||||
### Plugin Runtime Configuration
|
||||
|
||||
You can read runtime configuration data from your user using `Inspec::Config.cached.fetch_plugin_config("your-plugin-name")`, which will return a hash with indifferent access representing the user's config file `plugins` section pertaining to your plugin. See [the config file](https://www.inspec.io/docs/reference/config/) for more information.
|
||||
You can read runtime configuration data from your user using `Inspec::Config.cached.fetch_plugin_config("your-plugin-name")`, which will return a hash with indifferent access representing the user's config file `plugins` section pertaining to your plugin. See [the config file](https://docs.chef.io/inspec/config/) for more information.
|
||||
|
||||
Do not store or read configuration information from plugins.json.
|
||||
|
||||
|
|
|
@ -50,26 +50,29 @@ to build Chef's documentation from multiple repositories. The Hugo modules are
|
|||
pinned to commits in each repository, and the documentation files from those
|
||||
repositories and commits are vendored in `chef/chef-web-docs`. When the documentation
|
||||
is updated in a repository, those changes won't appear in docs.chef.io until the
|
||||
Hugo modules are updated to the new commit and then vendored files are updated.
|
||||
Hugo modules are updated to the new commit and the vendored files are updated.
|
||||
|
||||
This can be useful if you want to update documentation in `inspec/inspec`, but
|
||||
don't want it to appear on docs.chef.io until a later date.
|
||||
We use Expeditor to submit a pull request to `chef/chef-web-docs` when Chef InSpec
|
||||
is promoted to stable.
|
||||
|
||||
To update the Hugo module for documentation in `inspec/inspec`:
|
||||
|
||||
1. Make sure your documentation changes are merged into master in `inspec/inspec`.
|
||||
1. Contact your friendly local Docs Team who will update the InSpec Hugo module for you.
|
||||
1. Make sure your documentation changes are merged into master in `inspec/inspec/docs-chef-io`.
|
||||
1. Wait for Expeditor to submit a PR to `chef/chef-web-docs` after Chef InSpec is promoted to stable.
|
||||
|
||||
If you need to manually update the Chef InSpec documentation, you can contact your
|
||||
friendly local Docs Team who will update the Automate Hugo module for you.
|
||||
|
||||
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/docs-chef-io`
|
||||
1. `hugo mod tidy`
|
||||
1. `hugo mod vendor`
|
||||
1. Submit a pull request to `chef/chef-web-docs`.
|
||||
|
||||
This will updated the InSpec vendored files in `chef-web-docs/_vendor/github.com/inspec/inspec/www`,
|
||||
This will updated the InSpec vendored files in `chef-web-docs/_vendor/github.com/inspec/inspec/docs-chef-io`,
|
||||
and update the commits in the go.mod and go.sum files in chef-web-docs.
|
||||
|
||||
## Local Development Environment
|
||||
|
@ -109,7 +112,7 @@ documentation changes as they would appear on docs.chef.io.
|
|||
|
||||
### make serve
|
||||
|
||||
`make serve` will preview the documentation that only exists in `inspec/inspec/www`.
|
||||
`make serve` will preview the documentation that only exists in `inspec/inspec/docs-chef-io`.
|
||||
This also shows a preview page that includes page metadata which can be useful
|
||||
for changing where a page exists in the left navigation menu.
|
||||
|
||||
|
|
|
@ -34,4 +34,4 @@ include_controls 'linux'
|
|||
include_controls 'windows-patch-benchmark'
|
||||
```
|
||||
|
||||
Further details are described in our [InSpec Docs](https://www.inspec.io/docs/reference/profiles/)
|
||||
Further details are described in our [InSpec Docs](https://docs.chef.io/inspec/profiles/)
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# InSpec Plugin Example - Resource Lister
|
||||
|
||||
This plugin provides an example of building a plugin for use with [InSpec](https://inspec.io). Its functionality is simple, but useful: list resources included with InSpec.
|
||||
This plugin provides an example of building a plugin for use with [InSpec](https://community.chef.io/products/chef-inspec/). Its functionality is simple, but useful: list resources included with InSpec.
|
||||
|
||||
## To Install this as a User
|
||||
|
||||
|
|
|
@ -26,7 +26,7 @@ Creating new profile at /Users/spaterson/my-profile
|
|||
aws_vpc_id: 'custom-vpc-id'
|
||||
```
|
||||
|
||||
The related control will simply be skipped if this is not provided. See the [InSpec DSL documentation](https://www.inspec.io/docs/reference/dsl_inspec/) for more details on conditional execution using `only_if`.
|
||||
The related control will simply be skipped if this is not provided. See the [InSpec DSL documentation](https://docs.chef.io/inspec/dsl_inspec/) for more details on conditional execution using `only_if`.
|
||||
|
||||
## Run the tests
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ Note the `2` in the reporter name. If you omit it and run `--reporter html` inst
|
|||
|
||||
## Configuring the Plugin
|
||||
|
||||
The `html2` reporter requires no configuration to function. However, two options--`alternate_css_file` and `alternate_js_file`--are available for customization. The options are set in the JSON-formatted configuration file that Chef InSpec consumes. For details, see [our configuration file documentation](https://www.inspec.io/docs/reference/config/).
|
||||
The `html2` reporter requires no configuration to function. However, two options--`alternate_css_file` and `alternate_js_file`--are available for customization. The options are set in the JSON-formatted configuration file that Chef InSpec consumes. For details, see [our configuration file documentation](https://docs.chef.io/inspec/config/).
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
@ -26,7 +26,7 @@ Creating new profile at /Users/spaterson/my-profile
|
|||
aws_vpc_id: 'custom-vpc-id'
|
||||
```
|
||||
|
||||
The related control will simply be skipped if this is not provided. See the [InSpec DSL documentation](https://www.inspec.io/docs/reference/dsl_inspec/) for more details on conditional execution using `only_if`.
|
||||
The related control will simply be skipped if this is not provided. See the [InSpec DSL documentation](https://docs.chef.io/inspec/dsl_inspec/) for more details on conditional execution using `only_if`.
|
||||
|
||||
## Run the tests
|
||||
|
||||
|
|
|
@ -34,4 +34,4 @@ include_controls 'linux'
|
|||
include_controls 'windows-patch-benchmark'
|
||||
```
|
||||
|
||||
Further details are described in our [InSpec Docs](https://www.inspec.io/docs/reference/profiles/)
|
||||
Further details are described in our [InSpec Docs](https://docs.chef.io/inspec/profiles/)
|
||||
|
|
Loading…
Reference in a new issue