diff options
| author | Tim Smith <tsmith84@gmail.com> | 2020-05-28 11:11:23 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2020-05-28 11:11:23 -0700 |
| commit | 008f083d470cf747ae4b56dea77bf75ad8599263 (patch) | |
| tree | 53f61e246c33a86cf14d6e284eb3a29ab8d8a8d2 /docs/dev | |
| parent | b49c1d7f1eeed3ceb7bc35406dd802f582a3c25c (diff) | |
| download | chef-008f083d470cf747ae4b56dea77bf75ad8599263.tar.gz | |
Improve auto-generated docs
Add more descriptions and examples
Remove some smart quotes
Make sure homebrew_package gets tagged as supporting multi-package
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/design_documents/resource_load_and_converge_methods.md | 1 | ||||
| -rw-r--r-- | docs/dev/how_to/bumping_the_major_version.md | 6 |
2 files changed, 3 insertions, 4 deletions
diff --git a/docs/dev/design_documents/resource_load_and_converge_methods.md b/docs/dev/design_documents/resource_load_and_converge_methods.md index b7046d1892..00b074578b 100644 --- a/docs/dev/design_documents/resource_load_and_converge_methods.md +++ b/docs/dev/design_documents/resource_load_and_converge_methods.md @@ -30,7 +30,6 @@ When the resource writer defines `load_current_value` on the resource class, it 2. Copy all non-desired-state values from the desired resource into the new instance. 3. Call `load_current_value` on the new instance. - ```ruby class File < Chef::Resource property :path, name_attribute: true diff --git a/docs/dev/how_to/bumping_the_major_version.md b/docs/dev/how_to/bumping_the_major_version.md index 17332bf765..ff93f5bcf6 100644 --- a/docs/dev/how_to/bumping_the_major_version.md +++ b/docs/dev/how_to/bumping_the_major_version.md @@ -8,7 +8,7 @@ Chef consumes Ohai from GitHub as both a runtime dependency and a testing depend ### Create a new stable branch of Ohai -On your local machine fork the current master branch to a new stable branch. For example: `git checkout -b 15-stable`. You’ll then want to edit the Expeditor config.yml file to update the branch configs like this: +On your local machine fork the current master branch to a new stable branch. For example: `git checkout -b 15-stable`. You'll then want to edit the Expeditor config.yml file to update the branch configs like this: https://github.com/chef/ohai/commit/ad208165619425dd7886b2de3f168b49ded25146 @@ -29,9 +29,9 @@ On your local machine fork the current master branch to a new stable branch. For ### Create a branch to fixup your new stable branch for release -Once you’ve forked to a new stable branch such as `chef-15` you’ll want to create a new branch so you can build a PR, which will get this branch ready for release: +Once you've forked to a new stable branch such as `chef-15` you'll want to create a new branch so you can build a PR, which will get this branch ready for release: -- In ./expeditor/config.yml add the version_constraint for the new branch, update the version_constraint for master to match the new major version, and remove all the update_dep.sh subscriptions which don’t work against stable branches. +- In ./expeditor/config.yml add the version_constraint for the new branch, update the version_constraint for master to match the new major version, and remove all the update_dep.sh subscriptions which don't work against stable branches. - In readme.md update the buildkite badge to point to the new stable branch image and link instead of pointing to master. - In kitchen-tests/Gemfile update the Ohai branch to point to the new Ohai stable - In kitchen-tests/kitchen.yml update chef_version to be your new stable version and not current. Ex: 15 |