Skip to content

Commit

Permalink
DOCS-2275 Lint README (#807)
Browse files Browse the repository at this point in the history
* DOCS-2275 Lint READMME

* Apply suggestions from code review

Co-authored-by: Kari Halsted <12926135+kayayarai@users.noreply.github.com>
  • Loading branch information
ruthnaebeck and kayayarai authored Aug 4, 2021
1 parent e26ac80 commit 39ad158
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Datadog Chef recipes are used to deploy Datadog's components and configurati
* Datadog Agent v6.x
* Datadog Agent v5.x

**Note**: This page may refer to features that are not available for your selected version. Check the README of the
**Note**: This page may discuss features that are not available for your selected version. Check the README of the
git tag or gem version for your version's documentation.

## Setup
Expand Down Expand Up @@ -275,14 +275,14 @@ The [dd-agent recipe][9] installs the Datadog Agent on the target system, sets y

### Handler

The [dd-handler recipe][11] installs the [chef-handler-datadog][12] gem and invokes the handler at the end of a Chef run to report the details to the newsfeed.
The [dd-handler recipe][11] installs the [chef-handler-datadog][12] gem and invokes the handler at the end of a Chef run to report the details to the news feed.

### DogStatsD

To install a language-specific library that interacts with DogStatsD:

- Ruby: [dogstatsd-ruby recipe][13]
- Python: Add a dependency on the `poise-python` cookbook to your custom/wrapper cookbook, and use the resource below. For more details, refer to the [poise-python repository][14].
- Python: Add a dependency on the `poise-python` cookbook to your custom/wrapper cookbook, and use the resource below. For more details, see the [poise-python repository][14].
```ruby
python_package 'dogstatsd-python' # assumes python and pip are installed
```
Expand All @@ -292,7 +292,7 @@ To install a language-specific library that interacts with DogStatsD:
To install a language-specific library for application tracing (APM):

- Ruby: [ddtrace-ruby recipe][15]
- Python: Add a dependency on the `poise-python` cookbook to your custom/wrapper cookbook, and use the resource below. For more details, refer to the [poise-python repository][14].
- Python: Add a dependency on the `poise-python` cookbook to your custom/wrapper cookbook, and use the resource below. For more details, see the [poise-python repository][14].
```ruby
python_package 'ddtrace' # assumes python and pip are installed
```
Expand Down Expand Up @@ -332,7 +332,7 @@ end
| `instances` | The fields used to fill values under the `instances` section in the integration configuration file. |
| `init_config` | The fields used to fill values under the the `init_config` section in the integration configuration file. |
| `logs` | The fields used to fill values under the the `logs` section in the integration configuration file. |
| `use_integration_template` | Set to `true` (recommended) to use the default template, which writes the values of `instances`, `init_config`, and `logs` in the YAML under their respective keys. This defaults to `false` for backward compatibility, but will default to `true` in a future major version of the cookbook. |
| `use_integration_template` | Set to `true` (recommended) to use the default template, which writes the values of `instances`, `init_config`, and `logs` in the YAML under their respective keys. This defaults to `false` for backward compatibility, but may default to `true` in a future major version of the cookbook. |

#### Example

Expand Down Expand Up @@ -391,7 +391,7 @@ datadog_integration 'datadog-elastic' do
end
```

To get the available versions of the integrations, refer to the integration-specific `CHANGELOG.md` in the [integrations-core repository][16].
To get the available versions of the integrations, see the integration-specific `CHANGELOG.md` in the [integrations-core repository][16].

**Note**: For Chef Windows users, the `chef-client` must have read access to the `datadog.yaml` file when the `datadog-agent` binary available on the node is used by this resource.

Expand Down

0 comments on commit 39ad158

Please sign in to comment.