Skip to content

Commit a942a78

Browse files
committed
Additional corrections
Signed-off-by: Ian Maddaus <[email protected]>
1 parent e200548 commit a942a78

13 files changed

+33
-33
lines changed

archetypes/all_the_resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The following properties are common to every resource:
7070
`sensitive`
7171
: **Ruby Type:** true, false | **Default Value:** `false`
7272

73-
Ensure that sensitive resource data is not logged by Chef Infra Client.
73+
Ensure that sensitive resource data isn't logged by Chef Infra Client.
7474

7575
#### Examples
7676

content/attribute_precedence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ When the default attribute precedence `node['foo']['bar']` is removed:
227227
node.rm_default('foo', 'bar') #=> {'baz' => 52, 'thing' => 'allthestuff'}
228228
```
229229

230-
What is left under `'foo'` is only `'bat'`:
230+
What's left under `'foo'` is only `'bat'`:
231231

232232
```ruby
233233
node.attributes.combined_default['foo'] #=> {'bat' => { 'things' => [5,6] } }

content/azure_cwa_cloud_shell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ need for a local shell.
3737
## Azure Cloud Shell Installation
3838

3939
Ensure you have an accessible Azure Cloud Shell instance. You may need
40-
to create a storage account to use Azure Cloud Shell if you have not used
40+
to create a storage account to use Azure Cloud Shell if you haven't used
4141
it before in this tenant. For more information on accessing, setting up,
4242
and using Azure Cloud Shell, see the [Cloud Shell
4343
Documentation](https://docs.microsoft.com/en-us/azure/cloud-shell/quickstart).

content/community_contributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ By making a contribution to this project, I certify that:
107107
Indicated in the file; or
108108

109109
(c) The contribution was provided directly to me by some other
110-
person who certified (a), (b) or (c) and I have not modified
110+
person who certified (a), (b) or (c) and I haven't modified
111111
it.
112112

113113
(d) I understand and agree that this project and the contribution

content/community_guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ that behavior. The Community Advocate may:
233233
- Allow time for the violator to correct the behavior.
234234

235235
The Community Advocate should take the following steps if the behavior
236-
is not brought in-line with our guidelines or the incident isn't
236+
isn't brought in-line with our guidelines or the incident isn't
237237
resolved:
238238

239239
- Consult with another Community Organizer to make a judgment call

content/ctl_chef_client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -687,9 +687,9 @@ Infra Client on a logical partition (LPAR). When the system process
687687
limits are too low, the Chef Infra Client won't be able to create
688688
threads. To increase the system process limits:
689689

690-
1. Validate that the system process limits have not already been increased.
690+
1. Validate that the system process limits haven't already been increased.
691691
692-
2. If they have not been increased, run the following commands as a root user:
692+
2. If they haven't been increased, run the following commands as a root user:
693693

694694
```bash
695695
chsec -f /etc/security/limits -s default -a "rss=-1"

content/custom_resources_notes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ end
9292

9393
## Library Resources/Providers
9494

95-
Library resources are discouraged since you can shoot yourself in the foot. They used to be encouraged back before Chef Infra Client 12.0 `provides` was introduced since it allowed for renaming the resource so that it did not have to be prefixed by the cookbook name.
95+
Library resources are discouraged since you can shoot yourself in the foot. They used to be encouraged back before Chef Infra Client 12.0 `provides` was introduced since it allowed for renaming the resource so that it didn't have to be prefixed by the cookbook name.
9696

97-
There are many ways to go wrong writing library providers. One of the biggest issues is that internal Chef Infra Client code superficially looks like a library provider, but it's not. Chef internal resources don't inherit from `LWRPBase` and we've had to manually create resources directly through `Chef::Resource::File.new()`, we also have not been able to `use_inline_resources` and not had access to other niceties that cookbook authors have had access to for years now. We've got some modernization of internal Chef cookbook code now and resources like `apt_update` and `apt_repository` in core have started to be written more like cookbook code should be written, but core resources are actually behind the curve and are bad code examples.
97+
There are many ways to go wrong writing library providers. One of the biggest issues is that internal Chef Infra Client code superficially looks like a library provider, but it's not. Chef internal resources don't inherit from `LWRPBase` and we've had to manually create resources directly through `Chef::Resource::File.new()`, we also haven't been able to `use_inline_resources` and not had access to other niceties that cookbook authors have had access to for years now. We've got some modernization of internal Chef cookbook code now and resources like `apt_update` and `apt_repository` in core have started to be written more like cookbook code should be written, but core resources are actually behind the curve and are bad code examples.
9898

9999
in `libraries/resource_my_resource.rb`:
100100

@@ -176,7 +176,7 @@ action :run do
176176
end
177177
```
178178

179-
That is the magic of `use_inline_resources` (and why `use_inline_resources` is turned on by default in Chef Infra Client 12.5 resources) The sub-resources are defined in a sub-resource collection which is compiled and converged as part of the provider executing. Any resources that update in the sub-resource collection cause the resource itself to be updated automatically. Notifications then fire normally off the resource. It also works to arbitrary levels of nesting of sub-sub-sub-resources being updating causing the wrapping resources to update and fire notifications.
179+
That's the magic of `use_inline_resources` (and why `use_inline_resources` is turned on by default in Chef Infra Client 12.5 resources) The sub-resources are defined in a sub-resource collection which is compiled and converged as part of the provider executing. Any resources that update in the sub-resource collection cause the resource itself to be updated automatically. Notifications then fire normally off the resource. It also works to arbitrary levels of nesting of sub-sub-sub-resources being updating causing the wrapping resources to update and fire notifications.
180180

181181
This also gets the why-run case correct. If all the work that you do in your resource is done by calling sub-resources, then why-run should work automatically. All your sub-resources will be NO-OP'd and will report what they would have done instead of doing it.
182182

content/deprecations_attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aliases = "/deprecations_attributes.html"
1010

1111
+++
1212

13-
We are continuously improving and streamlining the way attributes work
13+
We're continuously improving and streamlining the way attributes work
1414
in Chef, to make it easier for users to reason about and safely
1515
configure their servers.
1616

content/deprecations_custom_resource_cleanups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases = "/deprecations_custom_resource_cleanups.html"
99

1010
+++
1111

12-
We are continuously improving and streamlining the way custom resources
12+
We're continuously improving and streamlining the way custom resources
1313
work in Chef, to make it easier for cookbook authors and Chef developers
1414
to build resources.
1515

@@ -39,7 +39,7 @@ Otherwise, remove the `default: nil` statement from the property.
3939
## Invalid Defaults
4040

4141
Current versions of Chef emit a warning when a property's default value
42-
is not valid. This is often because the type of the default value
42+
isn't valid. This is often because the type of the default value
4343
doesn't match the specification of the property. For example:
4444

4545
```ruby

content/deprecations_namespace_collisions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ action :doit do
152152
end
153153
```
154154

155-
We are now enforcing this as the correct way to write resources.
155+
We're now enforcing this as the correct way to write resources.
156156

157157
Note that this namespace collision between custom resources and
158158
subresources occurs with properties that aren't also being immediately

0 commit comments

Comments
 (0)