Skip to content

Commit

Permalink
and so on
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <[email protected]>
  • Loading branch information
IanMadd committed Dec 17, 2024
1 parent 2924d2f commit e41892d
Show file tree
Hide file tree
Showing 19 changed files with 31 additions and 78 deletions.
2 changes: 1 addition & 1 deletion content/azure_chef_cli.md
Original file line number Diff line number Diff line change
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 Down
2 changes: 1 addition & 1 deletion content/chef_client_security.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The `trusted_certs` directory on Chef Workstation and in Chef Infra Client works

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 Down
2 changes: 1 addition & 1 deletion content/chef_deprecations_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ of Chef comes out.
</tr>
<tr>
<td><a href="/deprecations_map_collision/">CHEF-25</a></td>
<td>Resource(s) in a cookbook collide with the same resource(s) now included in Chef Infra Client.</td>
<td>Resources in a cookbook collide with the same resources now included in Chef Infra Client.</td>
<td>XX.X</td>
<td>15.0</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions content/community_contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Questions on how to use Chef Infra should be sent as Support Tickets if you have

## Contribution Process

We have a four step process for contributions:
Follow these steps to submit a contribution:

1. Fork the project repository to your own GitHub account.
2. Commit your changes to your fork, making sure to sign-off those changes for the Developer Certificate of Origin with `git commit -s`
Expand Down Expand Up @@ -114,7 +114,7 @@ By making a contribution to this project, I certify that:
are public and that a record of the contribution (including
all personal information I submit with it, including my
sign-off) is maintained indefinitely and may be redistributed
consistent with this project or the open source license(s)
consistent with this project or the open source licenses
involved.
```

Expand Down
47 changes: 0 additions & 47 deletions content/community_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,53 +133,6 @@ Community Organizers who don't follow or enforce the Code of Conduct in
good faith may face temporary or permanent repercussions as determined
by other members of the project's leadership.

## Roles

The following are the various roles of our **Community Organizers** and
the person(s) assigned to each role:

- The **Deciders** have final say on community guidelines and final
authority on correct actions and appeals.
- The **Community Advocates** may be assigned for each area where the
community convenes online (Slack, email list, GitHub, etc.).
Community Advocates are volunteers who have the best interests of
our community in mind. They act in good faith to help enforce our
community guidelines and respond to incidents when they occur.
- The **Project Maintainers** are expected to conduct their behavior
in line with the Code of Conduct and are individually responsible
for both escalating to a **Community Advocate** in case of
witnessing an incident, and helping to foster the community.
- A **Community Member** is anyone who participates with the community
whether in-person or using online channels. Community members are
responsible for following the community guidelines, suggesting
updates to the guidelines when warranted, and helping enforce
community guidelines.

<!-- markdownlint-disable MD033 -->

<table>
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="header">
<th>Role</th>
<th>Name</th>
<th>Contact Info</th>
</tr>
</thead>
<tbody>
<tr>
<td>Community Advocate</td>
<td>benny Vasquez</td>
<td><a href="[email protected]">[email protected]</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-enable MD033 -->

## Consequences of Unacceptable Behavior

Unacceptable behavior from any community member, including sponsors and
Expand Down
2 changes: 1 addition & 1 deletion content/ctl_chef_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ When running the Chef Infra Client using the `--local-mode` option,
Another example of running the Chef Infra Client as a non-root user
involves using resources to pass sudo commands as as an attribute on the
resource. For example, the **service** resource uses a series of
`_command` attributes (like `start_command`, `stop_command`, and so on),
`_command` attributes (like `start_command` or `stop_command`),
the **package**-based resources use the `options` attribute, and the
**script**-based resources use the `code` attribute.
Expand Down
6 changes: 3 additions & 3 deletions content/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ include:

* Using the **chef_handler** resource
* Using the chef-shell and the **breakpoint** resource to add breakpoints to recipes, and to then step through the recipes using the breakpoints
* Using the `debug_value` method from chef-shell to identify the location(s) from which attribute values are being set
* Using the `debug_value` method from chef-shell to identify the locations from which attribute values are being set
* Using the `ignore_failure` method in a recipe to force Chef Infra Client to move past an error to see what else is going on in the recipe, outside of a known failure
* Using chef-solo to run targeted Chef Infra Client runs for specific scenarios

Expand Down Expand Up @@ -335,9 +335,9 @@ where
* Each attribute value shown is the value that's set for that precedence level
* `:not_present` is shown for any attribute precedence level that has no attributes

### ignore_failure Method
### ignore_failure method

All resources share a set of common actions, attributes, and so on. Use the following attribute in a resource to help identify where an issue within a recipe may be located:
All resources share a set of common actions, attributes, and other properties. Use the following attribute in a resource to help identify where an issue within a recipe may be located:

| Attribute | Description |
|----------------|---------------------------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion content/deprecations_map_collision.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sitemapExclude = true
aliases = "/deprecations_map_collision.html"
+++

The resource(s) referenced in the error message has been loaded from a
The resources referenced in the error message has been loaded from a
cookbook. This resource is now included in Chef Infra Client and will
take precedence over the existing cookbook resource in the next major
release of Chef Infra Client (15.0, April 2019). Alternatively, there
Expand Down
2 changes: 1 addition & 1 deletion content/handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ A custom handler can be created to support any situation. The easiest way to bui

### Syntax

The syntax for a handler can vary, depending on what the the situations the handler is being asked to track, the type of handler being used, and so on. All custom exception and report handlers are defined using Ruby and must be a subclass of the `Chef::Handler` class.
The syntax for a handler can vary depending on what the situations the handler is being asked to track, for example the handler type being used. All custom exception and report handlers are defined using Ruby and must be a subclass of the `Chef::Handler` class.

```ruby
require 'chef/log'
Expand Down
14 changes: 7 additions & 7 deletions content/infra_language/editing_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ declare_resource(:resource_type, 'resource_name', resource_attrs_block)

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.
- `resource_attrs_block` is a block in which properties of the instantiated resource are declared.

Expand Down Expand Up @@ -55,7 +55,7 @@ delete_resource(:resource_type, 'resource_name')

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.

For example:
Expand All @@ -78,7 +78,7 @@ delete_resource!(:resource_type, 'resource_name')

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef Infra may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef Infra may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.

For example:
Expand All @@ -102,7 +102,7 @@ edit_resource(:resource_type, 'resource_name', resource_attrs_block)

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.
- `resource_attrs_block` is a block in which properties of the instantiated resource are declared.

Expand Down Expand Up @@ -142,7 +142,7 @@ edit_resource!(:resource_type, 'resource_name')

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.
- `resource_attrs_block` is a block in which properties of the instantiated resource are declared.

Expand All @@ -167,7 +167,7 @@ find_resource(:resource_type, 'resource_name')

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.

For example:
Expand Down Expand Up @@ -199,7 +199,7 @@ find_resource!(:resource_type, 'resource_name')

where:

- `:resource_type` is the resource type, such as `:file` (for the **file** resource), `:template` (for the **template** resource), and so on. Any resource available to Chef may be declared.
- `:resource_type` is the resource type, such as `:file` (for the **file** resource) or `:template` (for the **template** resource). Any resource available to Chef may be declared.
- `resource_name` the property that's the default name of the resource, typically the string that appears in the `resource 'name' do` block of a resource (but not always); see the Syntax section for the resource to be declared to verify the default name property.

For example:
Expand Down
2 changes: 1 addition & 1 deletion content/licensing/terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Licensed Unit
: "License Unit" types/metrics include node, entitled content, service instance, target and/or endpoint.

Measurement of License Units/License Consumption Data
: Measurement of usage of a license unit. It's a numerical value based on the bundle\SKU or add-on(s) customer has purchased.
: Measurement of usage of a license unit. It's a numerical value based on the bundle\SKU or add-ons customer has purchased.

Free-tier Users
: Users using a Free License of Chef (User will only get the executable but restricted in some way), not the code base.
Expand Down
8 changes: 4 additions & 4 deletions content/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ across the organization are unique.

For Chef Infra Client, two important aspects of nodes are groups of
attributes and run-lists. An attribute is a specific piece of data about
the node, such as a network interface, a file system, the number of
clients a service running on a node is capable of accepting, and so on.
the node, such as a network interface, a file system, or the number of
clients a service running on a node is capable of accepting.
A run-list is an ordered list of recipes and/or roles that are run in an
exact order. The node object consists of the run-list and node
attributes, which is a JSON file that's stored on the Chef Infra
Expand All @@ -83,8 +83,8 @@ copy on the Chef Infra Server at the end of each Chef Infra Client run.
### Attributes

An attribute is a specific detail about a node, such as an IP address, a
host name, a list of loaded kernel modules, the version(s) of available
programming languages that are available, and so on. An attribute may be
host name, a list of loaded kernel modules, the versions of available
programming languages that are available. An attribute may be
unique to a specific node or it can be identical across every node in
the organization. Attributes are most commonly set from a cookbook, by
using knife, or are retrieved by Ohai from each node before every Chef
Expand Down
2 changes: 1 addition & 1 deletion content/plugin_community.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following Ohai plugins are available from the open source community:
<tbody>
<tr>
<td><a href="https://github.com/demonccc/chef-ohai-plugins/blob/master/dell.rb">dell.rb</a></td>
<td>Adds some useful Dell server information to Ohai. For example: service tag, express service code, storage info, RAC info, and so on. To use this plugin, OMSA and SMBIOS applications need to be installed.</td>
<td>Adds some useful Dell server information to Ohai. For example, service tag, express service code, storage info, or RAC info. To use this plugin, OMSA and SMBIOS applications need to be installed.</td>
</tr>
<tr>
<td><a href="https://bitbucket.org/retr0h/ohai">ipmi.rb</a></td>
Expand Down
2 changes: 1 addition & 1 deletion content/policyfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Policyfiles make it easier to test and promote code safely with a simpler interf

### Focused System Workflows

The knife command line tool maps closely to the Chef Infra Server API and the objects defined by it: roles, environments, run-lists, cookbooks, data bags, nodes, and so on. Chef Infra Client assembles these pieces at run-time and configures a host to do useful work.
The knife command line tool maps closely to the Chef Infra Server API and the objects defined by it, such as roles, environments, run-lists, cookbooks, data bags, or nodes. Chef Infra Client assembles these pieces at run-time and configures a host to do useful work.

Policyfile focuses that workflow onto the entire system, rather than the individual components. For example, Policyfile describes whole systems, whereas each individual revision of the `Policyfile.lock.json` file uploaded to the Chef Infra Server describes a part of that system, inclusive of roles, environments, cookbooks, and the other Chef Infra Server objects necessary to configure that part of the system.

Expand Down
4 changes: 2 additions & 2 deletions content/release_notes_chefdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ The Kitchen Hyper-V driver has updated from 0.5.3 to 0.5.4, which resolves failu

**Kitchen DigitalOcean**

The Kitchen DigitalOcean driver has updated from 0.10.5 to 0.11.0. This release adds slugs for Ubuntu 20.04 / RHEL 8 / Fedora 31 support, increases the the default instance memory size to 1GB, and adds support for VPCs. Thanks [@zmaupin](https://github.com/zmaupin), [@tolland](https://github.com/tolland), and [@gregf](https://github.com/gregf) for these improvements.
The Kitchen DigitalOcean driver has updated from 0.10.5 to 0.11.0. This release adds slugs for Ubuntu 20.04 / RHEL 8 / Fedora 31 support, increases the default instance memory size to 1GB, and adds support for VPCs. Thanks [@zmaupin](https://github.com/zmaupin), [@tolland](https://github.com/tolland), and [@gregf](https://github.com/gregf) for these improvements.

**Kitchen EC2**

Expand Down Expand Up @@ -2247,7 +2247,7 @@ for examples of the new syntax.

The Chef CLI now includes a new option: <span class="title-ref">chef
update --exclude-deps</span> for policyfiles which will only update the
cookbook(s) given on the command line.
cookbooks given on the command line.

### Deprecations

Expand Down
2 changes: 1 addition & 1 deletion content/reusable/md/cookbook_file_specificity.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ default/apache2_module_conf_generate.pl

If the `apache2_module_conf_generate.pl` file was located in the
cookbook directory under `files/host-foo.example.com/`, the specified
file(s) would only be copied to the machine with the domain name
files would only be copied to the machine with the domain name
foo.example.com.

<!-- markdownlint-disable-file MD036 -->
Expand Down
2 changes: 1 addition & 1 deletion content/reusable/md/infra_lang_summary.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The Chef Infra Language is a comprehensive systems configuration language with resources and helpers for configuring operating systems. The language is primarily used in Chef Infra recipes and custom resources to tell the Chef Infra Client what action(s) to take to configure a system. The Chef Infra Language provides resources for system-level components such as packages, users, or firewalls, and it also includes helpers to allow you to make configuration decisions based on operating systems, clouds, virtualization hypervisors, and more.
The Chef Infra Language is a comprehensive systems configuration language with resources and helpers for configuring operating systems. The language is primarily used in Chef Infra recipes and custom resources to tell the Chef Infra Client what actions to take to configure a system. The Chef Infra Language provides resources for system-level components such as packages, users, or firewalls, and it also includes helpers to allow you to make configuration decisions based on operating systems, clouds, virtualization hypervisors, and more.
2 changes: 1 addition & 1 deletion content/reusable/md/ohai_automatic_attribute.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
An automatic attribute is a specific detail about a node, such as an IP
address, a host name, a list of loaded kernel modules, and so on.
address, a host name, or a list of loaded kernel modules.
Automatic attributes are detected by Ohai and are then used by Chef
Infra Client to ensure that they're handled properly during every Chef
Infra Client run. The most commonly accessed automatic attributes are:
Expand Down
Loading

0 comments on commit e41892d

Please sign in to comment.