Skip to content

Commit

Permalink
Fix contractions and other linting issues (#4358)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
IanMadd authored Dec 17, 2024
1 parent 248e487 commit 372c099
Show file tree
Hide file tree
Showing 202 changed files with 740 additions and 782 deletions.
2 changes: 1 addition & 1 deletion archetypes/all_the_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The following properties are common to every resource:
`sensitive`
: **Ruby Type:** true, false | **Default Value:** `false`

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

#### Examples

Expand Down
8 changes: 4 additions & 4 deletions content/attribute_arrays.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ override_attributes(
)
```

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:
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:

```ruby
override_attributes(
Expand All @@ -44,7 +44,7 @@ override_attributes(
)
```

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.
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.

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

Expand Down Expand Up @@ -115,7 +115,7 @@ to produce results like this:
}
```

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.
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.

## Attribute Array Logic

Expand Down Expand Up @@ -153,7 +153,7 @@ role_or_environment 2 { :x => '1' , :y => '2' }
{ :x => '1', :y => '2' }
```

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

### Addition

Expand Down
14 changes: 7 additions & 7 deletions content/attribute_precedence.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The attribute precedence order for the sources "roles" and "environments" are op
Applying the role `override` first lets you use the same role in a set of environments.
Applying the environment `override` on top of the role `override` lets you define a subset of these with environment-specific settings.

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.
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.

{{< /note >}}

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

```ruby
# Please do not ever do this in real code :)
# Please don't ever do this in real code :)
node.role_default['foo']['bar']['thing'] = 'otherstuff'
```

Expand All @@ -227,7 +227,7 @@ When the default attribute precedence `node['foo']['bar']` is removed:
node.rm_default('foo', 'bar') #=> {'baz' => 52, 'thing' => 'allthestuff'}
```

What is left under `'foo'` is only `'bat'`:
What's left under `'foo'` is only `'bat'`:

```ruby
node.attributes.combined_default['foo'] #=> {'bat' => { 'things' => [5,6] } }
Expand All @@ -252,7 +252,7 @@ node.default['foo'] = {
And some role attributes:

```ruby
# Please do not ever do this in real code :)
# Please don't ever do this in real code :)
node.role_default['foo']['bar']['thing'] = 'otherstuff'
```

Expand Down Expand Up @@ -425,7 +425,7 @@ Given the following code structure:

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

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

```ruby
# Please do not ever do this in real code :)
# Please don't ever do this in real code :)
node.role_default['foo']['bar']['baz'] = 55
node.force_default['foo']['bar']['baz'] = 66
```
Expand Down
6 changes: 3 additions & 3 deletions content/attribute_sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ draft = false
+++
<!-- markdownlint-disable-file MD036 -->

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

Expand Down Expand Up @@ -87,7 +87,7 @@ of the attribute priority methods:
- `normal_unless`

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

### attribute?

A useful method that is related to attributes is the `attribute?`
A useful method that's related to attributes is the `attribute?`
method. This method will check for the existence of an attribute, so
that processing can be done in an attributes file or recipe, but only if
a specific attribute exists.
Expand Down
4 changes: 2 additions & 2 deletions content/aws_marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ AWS provides five VPCs for each region. If you require more VPCs, please contact
1. Set the stack creation options:

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

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

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

1. Enter your **Username** and **Password** and select **Sign In**.
![ ](/images/chef_automate_login.png "Chef Automate Login")
Expand Down
8 changes: 4 additions & 4 deletions content/azure_chef_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ machines in Microsoft Azure.
### get-chef

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

#### Syntax

Expand Down Expand Up @@ -78,7 +78,7 @@ This command has the following options:

`-j JSON`, `--bootstrap-options JSON`

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

```bash
Expand Down Expand Up @@ -196,7 +196,7 @@ The extension has the following options that can be provided in the

`chef_node_name`

: 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.
: 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.

`chef_server_url`

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

`secret`

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

`validation_client_name`

Expand Down
2 changes: 1 addition & 1 deletion content/azure_cwa_cloud_shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ need for a local shell.
## Azure Cloud Shell Installation

Ensure you have an accessible Azure Cloud Shell instance. You may need
to create a storage account to use Azure Cloud Shell if you have not used
to create a storage account to use Azure Cloud Shell if you haven't used
it before in this tenant. For more information on accessing, setting up,
and using Azure Cloud Shell, see the [Cloud Shell
Documentation](https://docs.microsoft.com/en-us/azure/cloud-shell/quickstart).
6 changes: 3 additions & 3 deletions content/azure_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ on virtual machines in Microsoft Azure.
### Get-AzureVMChefExtension

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

#### Syntax

Expand Down Expand Up @@ -70,11 +70,11 @@ This cmdlet has the following options:

`-AutoUpdateChefClient`

: 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.
: 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.

`-BootstrapOptions <string>`

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

For example:

Expand Down
2 changes: 1 addition & 1 deletion content/azure_testdrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ product = ["client", "workstation", "automate"]

## Test Drive

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.
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.

### Get Started

Expand Down
8 changes: 4 additions & 4 deletions content/chef_client_security.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ aliases = ["/chef_client_security.html", "/auth.html"]

{{< warning >}}

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

{{< /warning >}}

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

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.

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).
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).

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

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

#### trusted_certs Locations

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

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

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:
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:

- Chef Infra Client: `/opt/chef/embedded/ssl/certs/cacert.pem`
- Chef Workstation: `/opt/chef-workstation/embedded/ssl/certs/cacert.pem`
Expand Down
Loading

0 comments on commit 372c099

Please sign in to comment.