Skip to content

Commit

Permalink
fix(style guide): Add color around agent vs integration
Browse files Browse the repository at this point in the history
  • Loading branch information
austin-schaefer committed Apr 14, 2022
1 parent 33f58fd commit a4a731d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/content/docs/style-guide/word-choice/usage-dictionary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ For consistency across New Relic content, here are our general word usage guidel

Style guidelines:

* Don't capitalize: use "the Ruby agent," not "the Ruby Agent."
* Don't capitalize: use `the Ruby agent`, not `the Ruby Agent`.
* Don't refer to a synthetics [`private minion`](/docs/synthetics/new-relic-synthetics/private-locations/install-configure-private-minions) as an `agent`.
* With regards to how the concept of "agents" relate to the concept of "integrations": agents can be understood as containing various integrations. For example, our APM agents have integrations with various app frameworks and web servers and types of databases. One way to frame this is: "The integrations included with our agents are just some of [our many integrations](https://newrelic.com/instant-observability)" or "Our agent-based integrations..."
* With regards to how `agents` relate `integrations`: An integration is anything not built by New Relic that we can inter-operate with. That could be something we monitor, an alerting service like PagerDuty, a service that pulls data from our APIs, etc. Agents are software that enable one or more integrations. For example, our APM agents have integrations with various app frameworks and web servers and types of databases. One way to frame this is: "The integrations included with our agents are just some of [our many integrations](https://newrelic.com/instant-observability)" or "Our agent-based integrations..."
</Collapser>

<Collapser
Expand Down

0 comments on commit a4a731d

Please sign in to comment.