diff options
| author | Tim Smith <tsmith@chef.io> | 2019-06-11 13:19:55 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-11 13:19:55 -0700 |
| commit | c5fd2247d295f0213581763228f3388bdb0e0ce5 (patch) | |
| tree | 2c8d56aaab0aa7a8b28a7c1539a3efeddecfdead | |
| parent | 7e96eb67c99c1a18f0ce8e6e7c0db60cb3399e94 (diff) | |
| download | chef-c5fd2247d295f0213581763228f3388bdb0e0ce5.tar.gz | |
Update docs/dev/how_to/releasing_chef_infra.md
Signed-off-by: Tim Smith <tsmith@chef.io>
Co-Authored-By: mjingle <mjingle@users.noreply.github.com>
| -rw-r--r-- | docs/dev/how_to/releasing_chef_infra.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/dev/how_to/releasing_chef_infra.md b/docs/dev/how_to/releasing_chef_infra.md index 3382f80457..01e6567dc4 100644 --- a/docs/dev/how_to/releasing_chef_infra.md +++ b/docs/dev/how_to/releasing_chef_infra.md @@ -16,7 +16,7 @@ The importance of our release notes cannot be understated. As developers we unde #### Overall Release Notes Structure -1. `New Resources`: If we ship new resources we want to make sure to brag about those resources. Use this section to give the elevator pitch for the new resource including an example of how it might be used if available. +1. `New Resources`: If we ship new resources, we want to make sure to brag about those resources. Use this section to give the elevator pitch for the new resource, including an example of how it might be used if available. 2. `Updated Resources`: It's important to let users know about new functionality in resources they may already be using. Cover any important bug fixes or new properties/actions here. 3. `Major new features`: Document new features with a high level bullet. This is a great opportunity to show off our work and sell users on new workflows. 4. `Updated InSpec Releases`: We should always call out the updated InSpec release with a description of new functionality included. |