Skip to content

Commit 372c099

Browse files
authored
Fix contractions and other linting issues (#4358)
* Fix contractions and other linting issues Signed-off-by: Ian Maddaus <[email protected]> * Corrections Signed-off-by: Ian Maddaus <[email protected]> * Correction Signed-off-by: Ian Maddaus <[email protected]> * Additional corrections Signed-off-by: Ian Maddaus <[email protected]> * More fixes Signed-off-by: Ian Maddaus <[email protected]> * and so on Signed-off-by: Ian Maddaus <[email protected]> * final fixes Signed-off-by: Ian Maddaus <[email protected]> --------- Signed-off-by: Ian Maddaus <[email protected]>
1 parent 248e487 commit 372c099

File tree

202 files changed

+740
-782
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+740
-782
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_arrays.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ override_attributes(
2929
)
3030
```
3131

32-
But what if all of the web servers are not the same? What if some of the web servers required a single attribute to have a different value? You could store these settings in two locations, once just like the preceding example and once just like the following:
32+
But what if all of the web servers aren't the same? What if some of the web servers required a single attribute to have a different value? You could store these settings in two locations, once just like the preceding example and once just like the following:
3333

3434
```ruby
3535
override_attributes(
@@ -44,7 +44,7 @@ override_attributes(
4444
)
4545
```
4646

47-
But that is not efficient, especially because most of them are identical. The deep merge capabilities of Chef Infra Client allows attributes to be layered across cookbooks, recipes, roles, and environments. This allows an attribute to be reused across nodes, making use of default attributes set at the cookbook level, but also providing a way for certain attributes (with a higher attribute precedence) to be applied only when they are supposed to be.
47+
But that isn't efficient, especially because most of them are identical. The deep merge capabilities of Chef Infra Client allows attributes to be layered across cookbooks, recipes, roles, and environments. This allows an attribute to be reused across nodes, making use of default attributes set at the cookbook level, but also providing a way for certain attributes (with a higher attribute precedence) to be applied only when they're supposed to be.
4848

4949
For example, a role named `baseline.rb`:
5050

@@ -115,7 +115,7 @@ to produce results like this:
115115
}
116116
```
117117

118-
Even though the `web.rb` file does not contain attributes and values for `minspareservers`, `maxspareservers`, `serverlimit`, `maxclients`, and `maxrequestsperchild`, the deep merge capabilities pulled them in.
118+
Even though the `web.rb` file doesn't contain attributes and values for `minspareservers`, `maxspareservers`, `serverlimit`, `maxclients`, and `maxrequestsperchild`, the deep merge capabilities pulled them in.
119119

120120
## Attribute Array Logic
121121

@@ -153,7 +153,7 @@ role_or_environment 2 { :x => '1' , :y => '2' }
153153
{ :x => '1', :y => '2' }
154154
```
155155

156-
When items cannot be merged through substitution, the original data is overwritten.
156+
When items can't be merged through substitution, the original data is overwritten.
157157

158158
### Addition
159159

content/attribute_precedence.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The attribute precedence order for the sources "roles" and "environments" are op
2929
Applying the role `override` first lets you use the same role in a set of environments.
3030
Applying the environment `override` on top of the role `override` lets you define a subset of these with environment-specific settings.
3131

32-
This is useful if you have an environment that is different within a sub-set of a role. For example, the role for an application server may exist in all environments, but one environment may use a different database server.
32+
This is useful if you have an environment that's different within a sub-set of a role. For example, the role for an application server may exist in all environments, but one environment may use a different database server.
3333

3434
{{< /note >}}
3535

@@ -211,7 +211,7 @@ node.default['foo'] = {
211211
And some role attributes:
212212

213213
```ruby
214-
# Please do not ever do this in real code :)
214+
# Please don't ever do this in real code :)
215215
node.role_default['foo']['bar']['thing'] = 'otherstuff'
216216
```
217217

@@ -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] } }
@@ -252,7 +252,7 @@ node.default['foo'] = {
252252
And some role attributes:
253253

254254
```ruby
255-
# Please do not ever do this in real code :)
255+
# Please don't ever do this in real code :)
256256
node.role_default['foo']['bar']['thing'] = 'otherstuff'
257257
```
258258

@@ -425,7 +425,7 @@ Given the following code structure:
425425

426426
```ruby
427427
node.default['foo']['bar'] = {'a' => 'b'}
428-
# Please do not ever do this in real code :)
428+
# Please don't ever do this in real code :)
429429
node.role_default['foo']['bar'] = {'c' => 'd'}
430430
node.default!['foo']['bar'] = {'d' => 'e'}
431431
```
@@ -443,7 +443,7 @@ Given the following code structure:
443443

444444
```ruby
445445
node.default['foo']['bar'] = {'a' => 'b'}
446-
# Please do not ever do this in real code :)
446+
# Please don't ever do this in real code :)
447447
node.role_default['foo']['bar'] = {'c' => 'd'}
448448
node.force_default!['foo']['bar'] = {'d' => 'e'}
449449
```
@@ -473,7 +473,7 @@ node.default['foo'] = {
473473
And some attributes:
474474

475475
```ruby
476-
# Please do not ever do this in real code :)
476+
# Please don't ever do this in real code :)
477477
node.role_default['foo']['bar']['baz'] = 55
478478
node.force_default['foo']['bar']['baz'] = 66
479479
```

content/attribute_sources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ draft = false
1010
+++
1111
<!-- markdownlint-disable-file MD036 -->
1212

13-
Chef Infra Client evaluates attributes in the order that they are defined in the
13+
Chef Infra Client evaluates attributes in the order that they're defined in the
1414
run-list, including any attributes that are in the run-list as
1515
cookbook dependencies.
1616

@@ -87,7 +87,7 @@ of the attribute priority methods:
8787
- `normal_unless`
8888

8989
Use the `_unless` variants carefully (and only when necessary) because
90-
when they are used, attributes applied to nodes may become out of sync
90+
when they're used, attributes applied to nodes may become out of sync
9191
with the values in the cookbooks as these cookbooks are updated. This
9292
approach can create situations where two otherwise identical nodes end
9393
up having slightly different configurations and can also be a challenge
@@ -104,7 +104,7 @@ Use the following methods within the attributes file for a cookbook or within a
104104

105105
### attribute?
106106

107-
A useful method that is related to attributes is the `attribute?`
107+
A useful method that's related to attributes is the `attribute?`
108108
method. This method will check for the existence of an attribute, so
109109
that processing can be done in an attributes file or recipe, but only if
110110
a specific attribute exists.

content/aws_marketplace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ AWS provides five VPCs for each region. If you require more VPCs, please contact
101101
1. Set the stack creation options:
102102

103103
Timeout
104-
: If specified and stack creation is not completed in that time, CloudFormation will roll back the stack.
104+
: If specified and stack creation isn't completed in that time, CloudFormation will roll back the stack.
105105

106106
Termination Protection
107107
: Termination protection prevents a user from deleting a stack.
@@ -118,7 +118,7 @@ For additional information about these options, see [Amazon's documentation on C
118118
1. Open your browser and paste the Chef Automate URL, which will open an alert page.
119119

120120
1. Select **Advanced** and continue.
121-
![Select 'advanced' to bypass the warning that the page is not secure](/images/NotSecurePage.png "Not Secure Page").
121+
![Select 'advanced' to bypass the warning that the page isn't secure](/images/NotSecurePage.png "Not Secure Page").
122122

123123
1. Enter your **Username** and **Password** and select **Sign In**.
124124
![ ](/images/chef_automate_login.png "Chef Automate Login")

content/azure_chef_cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ machines in Microsoft Azure.
2929
### get-chef
3030

3131
Use the `get-chef` command to get the details for the Azure Chef
32-
Extension that is running on the named virtual machine.
32+
Extension that's running on the named virtual machine.
3333

3434
#### Syntax
3535

@@ -78,7 +78,7 @@ This command has the following options:
7878

7979
`-j JSON`, `--bootstrap-options JSON`
8080

81-
: A JSON string that is added to the first run of a Chef Infra Client.
81+
: A JSON string that's added to the first run of a Chef Infra Client.
8282
For example:
8383

8484
```bash
@@ -196,7 +196,7 @@ The extension has the following options that can be provided in the
196196

197197
`chef_node_name`
198198

199-
: Determines which configuration should be applied and sets the `client_name`, which is the name used when authenticating to a Chef Infra Server. The default value is the the Chef Infra Client FQDN, as detected by Ohai. In general, Chef recommends that you leave this setting blank and let Ohai assign the FQDN of the node as the `node_name` during each Chef Infra Client run.
199+
: Determines which configuration should be applied and sets the `client_name`, which is the name used when authenticating to a Chef Infra Server. The default value is the Chef Infra Client FQDN, as detected by Ohai. In general, Chef recommends that you leave this setting blank and let Ohai assign the FQDN of the node as the `node_name` during each Chef Infra Client run.
200200

201201
`chef_server_url`
202202

@@ -208,7 +208,7 @@ The extension has the following options that can be provided in the
208208

209209
`secret`
210210

211-
: The encryption key that is used for values contained within a data bag item.
211+
: The encryption key that's used for values contained within a data bag item.
212212

213213
`validation_client_name`
214214

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/azure_powershell.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ on virtual machines in Microsoft Azure.
2222
### Get-AzureVMChefExtension
2323

2424
Use the `Get-AzureVMChefExtension` cmdlet to get the details for the
25-
Azure Chef Extension that is running on the named virtual machine.
25+
Azure Chef Extension that's running on the named virtual machine.
2626

2727
#### Syntax
2828

@@ -70,11 +70,11 @@ This cmdlet has the following options:
7070

7171
`-AutoUpdateChefClient`
7272

73-
: Automatically update . Set to `true` to automatically update the version of the Azure Chef Extension when the virtual machine is restarted. For example, if this option is enabled, a virtual machine that has version `1205.12.2.0` will be updated automatically to `1205.12.2.1` when it is published.
73+
: Automatically update . Set to `true` to automatically update the version of the Azure Chef Extension when the virtual machine is restarted. For example, if this option is enabled, a virtual machine that has version `1205.12.2.0` will be updated automatically to `1205.12.2.1` when it's published.
7474

7575
`-BootstrapOptions <string>`
7676

77-
: A JSON string that is added to the first run of a Chef Infra Client.
77+
: A JSON string that's added to the first run of a Chef Infra Client.
7878

7979
For example:
8080

content/azure_testdrive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ product = ["client", "workstation", "automate"]
2222

2323
## Test Drive
2424

25-
A **Test Drive** is a ready-to-go environment that allows you to experience Chef Automate for free, without an Azure subscription (You will need a [Microsoft account](https://signup.live.com/). The Test Drive comes already provisioned---you do not need to download, set up, or configure it---instead, you can spend two hours evaluating the user experience, key features, and benefits of the product.
25+
A **Test Drive** is a ready-to-go environment that allows you to experience Chef Automate for free, without an Azure subscription (You will need a [Microsoft account](https://signup.live.com/). The Test Drive comes already provisioned---you don't need to download, set up, or configure it---instead, you can spend two hours evaluating the user experience, key features, and benefits of the product.
2626

2727
### Get Started
2828

content/chef_client_security.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ aliases = ["/chef_client_security.html", "/auth.html"]
3131

3232
{{< warning >}}
3333

34-
The following information applies to on-premises Chef Infra Server and does not apply to Hosted Chef.
34+
The following information applies to on-premises Chef Infra Server and doesn't apply to Hosted Chef.
3535

3636
{{< /warning >}}
3737

@@ -41,11 +41,11 @@ The following information applies to on-premises Chef Infra Server and does not
4141

4242
Your organization may use a private Certificate Authority (CA) to generate SSL Certificates or they may create self-signed SSL certificates to use on internal networks or during software development and testing.
4343

44-
The `trusted_certs` directory on Chef Workstation and in Chef Infra Client works as a trusted certificate store for all communication in the Chef Infra system. Chef Infra trusts all SSL certificates stored in this directory--including certificates that are not issued by a trusted Certificate Authority (CA).
44+
The `trusted_certs` directory on Chef Workstation and in Chef Infra Client works as a trusted certificate store for all communication in the Chef Infra system. Chef Infra trusts all SSL certificates stored in this directory--including certificates that aren't issued by a trusted Certificate Authority (CA).
4545

4646
Place private and self-signed certificates in the `trusted_certs` directory to use them within Chef Infra Client and Workstation tools.
4747

48-
Use the the [chef_client_trusted_certificate]({{< relref "/resources/chef_client_trusted_certificate" >}}) Chef Infra Client resource to manage these certificates continuously.
48+
Use the [chef_client_trusted_certificate]({{< relref "/resources/chef_client_trusted_certificate" >}}) Chef Infra Client resource to manage these certificates continuously.
4949

5050
#### trusted_certs Locations
5151

@@ -67,7 +67,7 @@ When you bootstrap a node, the Chef Infra Client copies the SSL certificates for
6767

6868
Use the `SSL_CERT_FILE` environment variable to specify the location for the SSL certificate authority (CA) bundle for Chef Infra Client.
6969

70-
A value for `SSL_CERT_FILE` is not set by default. Unless updated, the locations in which Chef Infra will look for SSL certificates are:
70+
A value for `SSL_CERT_FILE` isn't set by default. Unless updated, the locations in which Chef Infra will look for SSL certificates are:
7171

7272
- Chef Infra Client: `/opt/chef/embedded/ssl/certs/cacert.pem`
7373
- Chef Workstation: `/opt/chef-workstation/embedded/ssl/certs/cacert.pem`

0 commit comments

Comments
 (0)