diff --git a/content/azure_chef_cli.md b/content/azure_chef_cli.md index 7ae100a40e..53fe0e3f22 100644 --- a/content/azure_chef_cli.md +++ b/content/azure_chef_cli.md @@ -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` diff --git a/content/chef_client_security.md b/content/chef_client_security.md index 57e1408f05..3db46af390 100644 --- a/content/chef_client_security.md +++ b/content/chef_client_security.md @@ -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 diff --git a/content/chef_deprecations_client.md b/content/chef_deprecations_client.md index 23bcdba341..151329fbfa 100644 --- a/content/chef_deprecations_client.md +++ b/content/chef_deprecations_client.md @@ -246,7 +246,7 @@ of Chef comes out. CHEF-25 -Resource(s) in a cookbook collide with the same resource(s) now included in Chef Infra Client. +Resources in a cookbook collide with the same resources now included in Chef Infra Client. XX.X 15.0 diff --git a/content/community_contributions.md b/content/community_contributions.md index 177a331781..336b78b609 100644 --- a/content/community_contributions.md +++ b/content/community_contributions.md @@ -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` @@ -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. ``` diff --git a/content/community_guidelines.md b/content/community_guidelines.md index 808c0bf911..c00f0175ad 100644 --- a/content/community_guidelines.md +++ b/content/community_guidelines.md @@ -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. - - - - ----- - - - - - - - - - - - - - - -
RoleNameContact Info
Community Advocatebenny Vasquezbenny.vasquez@progress.com
- - ## Consequences of Unacceptable Behavior Unacceptable behavior from any community member, including sponsors and diff --git a/content/ctl_chef_client.md b/content/ctl_chef_client.md index 0b5a4b1e66..45fce5f883 100644 --- a/content/ctl_chef_client.md +++ b/content/ctl_chef_client.md @@ -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. diff --git a/content/debug.md b/content/debug.md index d918170298..3056fd0bc0 100644 --- a/content/debug.md +++ b/content/debug.md @@ -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 @@ -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 | |----------------|---------------------------------------------------------------------------------------| diff --git a/content/deprecations_map_collision.md b/content/deprecations_map_collision.md index 12d59cdf60..e56171fe61 100644 --- a/content/deprecations_map_collision.md +++ b/content/deprecations_map_collision.md @@ -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 diff --git a/content/handlers.md b/content/handlers.md index 1f4636f801..7643971fe8 100644 --- a/content/handlers.md +++ b/content/handlers.md @@ -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' diff --git a/content/infra_language/editing_resources.md b/content/infra_language/editing_resources.md index b7a7ec199a..8bbda6e505 100644 --- a/content/infra_language/editing_resources.md +++ b/content/infra_language/editing_resources.md @@ -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. @@ -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: @@ -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: @@ -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. @@ -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. @@ -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: @@ -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: diff --git a/content/licensing/terms.md b/content/licensing/terms.md index 35da094a46..1dbb9452ba 100644 --- a/content/licensing/terms.md +++ b/content/licensing/terms.md @@ -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. diff --git a/content/nodes.md b/content/nodes.md index 18e63b388a..78445a50e1 100644 --- a/content/nodes.md +++ b/content/nodes.md @@ -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 @@ -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 diff --git a/content/plugin_community.md b/content/plugin_community.md index 50b0a2b081..6e16e3429d 100644 --- a/content/plugin_community.md +++ b/content/plugin_community.md @@ -36,7 +36,7 @@ The following Ohai plugins are available from the open source community: dell.rb -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. +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. ipmi.rb diff --git a/content/policyfile.md b/content/policyfile.md index e17c4a4b9c..6892a90f31 100644 --- a/content/policyfile.md +++ b/content/policyfile.md @@ -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. diff --git a/content/release_notes_chefdk.md b/content/release_notes_chefdk.md index 8e1a4f70fb..d4204c66cd 100644 --- a/content/release_notes_chefdk.md +++ b/content/release_notes_chefdk.md @@ -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** @@ -2247,7 +2247,7 @@ for examples of the new syntax. The Chef CLI now includes a new option: chef update --exclude-deps for policyfiles which will only update the -cookbook(s) given on the command line. +cookbooks given on the command line. ### Deprecations diff --git a/content/reusable/md/cookbook_file_specificity.md b/content/reusable/md/cookbook_file_specificity.md index 1636aa39b3..9ee7b22b26 100644 --- a/content/reusable/md/cookbook_file_specificity.md +++ b/content/reusable/md/cookbook_file_specificity.md @@ -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. diff --git a/content/reusable/md/infra_lang_summary.md b/content/reusable/md/infra_lang_summary.md index a147a682f6..8cf352b8ef 100644 --- a/content/reusable/md/infra_lang_summary.md +++ b/content/reusable/md/infra_lang_summary.md @@ -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. diff --git a/content/reusable/md/ohai_automatic_attribute.md b/content/reusable/md/ohai_automatic_attribute.md index 1ba4b4d999..b05e89e531 100644 --- a/content/reusable/md/ohai_automatic_attribute.md +++ b/content/reusable/md/ohai_automatic_attribute.md @@ -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: diff --git a/content/reusable/md/policyfile_rb_settings.md b/content/reusable/md/policyfile_rb_settings.md index bbbaa60cff..f1c4ed7a1e 100644 --- a/content/reusable/md/policyfile_rb_settings.md +++ b/content/reusable/md/policyfile_rb_settings.md @@ -6,7 +6,7 @@ A `Policyfile.rb` file may contain the following settings: : Required. The name of the policy. Use a name that reflects the purpose of the machines against which the policy will run, - such as "application server", "chat server", "load balancer", and so on. + such as _application server_, _chat server_, or _load balancer_. `run_list "ITEM", "ITEM", ...`