Skip to content

Commit

Permalink
Linting
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <[email protected]>
  • Loading branch information
IanMadd committed Nov 15, 2023
1 parent badcad2 commit 8a2e242
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions content/azure_chef_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This command has the following options:

`-a`, `--auto-update-client`

: Automatically update Chef Infra Client. 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. Default value: `false`.
: Automatically update Chef Infra Client. 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. Default value: `false`.

`-b`, `--disable`

Expand Down Expand Up @@ -148,13 +148,13 @@ The extension has the following options that can be provided in the

{{< note >}}

If using the Chef extension in an ARM template, it is recommended that you base64 encode your validation key and set this option to `base64encoded`
If using the Chef extension in an ARM template, it's recommended that you base64 encode your validation key and set this option to `base64encoded`

{{< /note >}}

`bootstrap_version`

: The version of Chef Infra Client that will be installed on the system. **linux only**
: The version of Chef Infra Client that will be installed on the system. **Linux only**

{{< note >}}
Due to constraints in Azure, the `bootstrap_version` option is only available on the `LinuxChefClient` extension.
Expand Down
4 changes: 2 additions & 2 deletions content/config_rb_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ This configuration file has the following settings:

{{< warning >}}

Use the `gem` setting only for making external chef libraries shipped as gems accessible in a Chef Infra Client run for libraries and attribute files. The `gem` setting in `metadata.rb` allows for the early installation of this specific type of gem, with the fundamental limitation that it cannot install native gems.
Use the `gem` setting only for making external chef libraries shipped as gems accessible in a Chef Infra Client run for libraries and attribute files. The `gem` setting in `metadata.rb` allows for the early installation of this specific type of gem, with the fundamental limitation that it can't install native gems.

Do not install native gems with the `gem` setting in `metadata.rb` . The `gem` setting is not a general purpose replacement for the [chef_gem resource](/resources/chef_gem/), and does not internally re-use the `chef_gem` resource. Native gems require C compilation and must not be installed with `metadata.rb` because `metadata.rb` runs before any recipe code runs. Consequently, Chef Infra Client cannot install the C compilers before the gem installation occurs. Instead, install native gems with the `chef_gem` resource called from the recipe code. You'll also need to use the `build_essential` resource in the recipe code to install the prerequisite compilers onto the system.
Don't install native gems with the `gem` setting in `metadata.rb`. The `gem` setting is not a general purpose replacement for the [chef_gem resource](/resources/chef_gem/), and does not internally re-use the `chef_gem` resource. Native gems require C compilation and must not be installed with `metadata.rb` because `metadata.rb` runs before any recipe code runs. Consequently, Chef Infra Client Linux install the C compilers before the gem installation occurs. Instead, install native gems with the `chef_gem` resource called from the recipe code. You'll also need to use the `build_essential` resource in the recipe code to install the prerequisite compilers onto the system.

Check failure on line 146 in content/config_rb_metadata.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/config_rb_metadata.md#L146

[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "content/config_rb_metadata.md", "range": {"start": {"line": 146, "column": 88}}}, "severity": "ERROR"}

Check failure on line 146 in content/config_rb_metadata.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/config_rb_metadata.md#L146

[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "content/config_rb_metadata.md", "range": {"start": {"line": 146, "column": 180}}}, "severity": "ERROR"}

Pure ruby gems can also be installed with `metadata.rb`.

Expand Down
2 changes: 1 addition & 1 deletion content/style/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Indent ordered sub-list items **3 spaces**.

1. This is a list item
1. This is another list item in the same list. The number you use in Markdown
does not necessarily correlate to the number in the final output. By
doesn't necessarily correlate to the number in the final output. By
convention, we keep them in sync.
1. {{< note >}}
For single-digit numbered lists, using two spaces after the period makes
Expand Down

0 comments on commit 8a2e242

Please sign in to comment.