[TEST] Demo changes for incorporate-pr-feedback skill#35261
[TEST] Demo changes for incorporate-pr-feedback skill#35261
Conversation
buraizu
left a comment
There was a problem hiding this comment.
Thanks for working on this! I've left a few comments on specific lines. Some of these are Vale violations that our linter will catch, and a couple are content/style concerns.
|
|
||
| ## Overview | ||
|
|
||
| This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding. |
There was a problem hiding this comment.
Vale: 'will walk' uses a temporal word ('will'). Revert to present tense: "This guide walks you through..."
|
|
||
| ## Overview | ||
|
|
||
| This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding. |
There was a problem hiding this comment.
Vale: 'Once you have completed setup' — use 'After you complete setup' instead. Also, 'easily' should be removed (Vale: words to avoid).
buraizu
left a comment
There was a problem hiding this comment.
Left several inline comments covering Vale violations and content concerns. These demonstrate the kinds of issues incorporate-pr-feedback can help apply.
|
|
||
| ## Overview | ||
|
|
||
| This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding. |
There was a problem hiding this comment.
Vale: 'will walk' uses a temporal word. Switch to present tense: "This guide walks you through..."
Also, 'Once you have completed setup' → 'After you complete setup' (Vale: use 'After' instead of 'Once').
Also, remove 'easily' — it's a filler word per the style guide.
Also, 'to ensure that all your data is collected' — 'ensure' should be avoided or replaced with 'helps ensure'. Consider simplifying: end the sentence at 'configure log forwarding.'
| This guide will walk you through the process of integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. Once you have completed setup, you can easily enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding to ensure that all your data is collected. | ||
|
|
||
| ## Prerequisites | ||
|
|
There was a problem hiding this comment.
Vale: 'Note that' should be replaced with 'Note:' per the Datadog style guide.
Also, the additional clause 'and administrative access to your AWS console' is useful context — keep it.
| @@ -130,15 +130,21 @@ Use the **Metric Collection** tab on the [AWS integration page][8] to configure | |||
|
|
|||
There was a problem hiding this comment.
Content: The 'Tag filtering' section uses several flagged phrases:
- 'leverage' → use 'use'
- 'utilizing' → use 'using'
- 'easily' → remove
- 'fine-tune' → use 'customize'
Suggested rewrite: "Use tag-based filtering to control which AWS resources Datadog monitors. Under the Metric Collection tab, add tag filters to include or exclude specific resources and customize your monitoring scope."
|
|
||
| ## Send logs | ||
|
|
||
| There are two ways to send AWS service logs to Datadog: |
There was a problem hiding this comment.
Vale: 'simplest' — avoid superlatives like 'simplest'. Consider: 'This option requires no additional infrastructure.'
|
|
||
| - [Amazon Data Firehose destination][10]: Recommended for high-volume CloudWatch logs. | ||
| - [Amazon Data Firehose destination][10]: Recommended for high-volume CloudWatch logs. This is the simplest option and requires no additional infrastructure. | ||
| - [Forwarder Lambda function][11]: Required for traces, enhanced metrics, or custom metrics from Lambda functions. Also recommended for logs from S3 or other resources that cannot stream directly to Amazon Data Firehose. |
There was a problem hiding this comment.
Vale + Style: Multiple issues in this tip:
- 'currently' is a temporal word — remove it
- 'easier to set up' — avoid comparatives like 'easier'; be specific instead
- The tip format ('Tip:') is non-standard for this doc site — use a 'Note:' callout or incorporate the guidance into the bullet list above instead.
Preview links (active after the
|
| ## Overview | ||
|
|
||
| This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding. | ||
| This guide will walk you through the process of integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. Once you have completed setup, you can easily enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding to ensure that all your data is collected. |
There was a problem hiding this comment.
Vale (multiple): Several issues on this line:
- 'will walk' uses a temporal word ('will'). Revert to present tense: 'This guide walks you through...'
- 'Once you have completed setup' → 'After you complete setup' ('Once' is flagged; use 'After')
- Remove 'easily' — filler word per the Datadog style guide
- 'to ensure that all your data is collected' — remove; it's redundant padding. End the sentence at 'configure log forwarding.'
Suggested rewrite: 'This guide walks you through integrating an Amazon Web Services (AWS) account with Datadog using Datadog's CloudFormation template. After completing setup, you can enable individual AWS service integrations, install the Datadog Agent on EC2 instances for deeper visibility, and configure log forwarding.'
| ## Prerequisites | ||
|
|
||
| Before you begin, ensure that you have an [AWS][7] account. The CloudFormation template creates an IAM role and associated policy, allowing Datadog's AWS account to make API calls to your AWS account to collect and push data. Your AWS user must have the following IAM permissions to run the template: | ||
| Before you begin, ensure you have an [AWS][7] account and administrative access to your AWS console. The CloudFormation template creates an IAM role and associated policy, allowing Datadog's AWS account to make API calls to your AWS account to collect and push data. Note that your AWS user must have the following IAM permissions to run the template: |
There was a problem hiding this comment.
Vale: 'Note that' should be replaced with 'Note:' — this is a direct Vale violation per the Datadog style guide.
Change to: 'Note: Your AWS user must have the following IAM permissions to run the template:'
| Under the **General** tab on the [AWS integration page][8], you can control the AWS regions where Datadog collects metrics, CloudWatch events, and resources. | ||
|
|
||
| ### Tag filtering | ||
|
|
There was a problem hiding this comment.
Vale (multiple): The new 'Tag filtering' section has several style guide violations:
- 'leverage' → 'use'
- 'utilizing' → 'using'
- 'easily' → remove
- 'fine-tune' → 'customize'
Suggested rewrite:
'Use tag-based filtering to control which AWS resources Datadog monitors. Add tag filters under the Metric Collection tab to include or exclude specific resources and customize your monitoring scope.'
| You can leverage tag-based filtering to control which AWS resources Datadog monitors. By utilizing tag filters under the **Metric Collection** tab, you can easily include or exclude specific resources. This allows you to fine-tune your monitoring setup to only collect metrics from the resources that matter to your team. | ||
|
|
||
| ## Send logs | ||
|
|
There was a problem hiding this comment.
Style: 'simplest' is a superlative that implies ease — avoid these per the style guide. Change to something more factual: 'This option requires no additional infrastructure.'
|
|
||
| See [Enable logging for your AWS service][14] for setup instructions. | ||
|
|
||
| **Tip**: If you are currently unsure which method to use, start with the Amazon Data Firehose destination, as it is easier to set up and maintain. |
There was a problem hiding this comment.
Vale + Structure: Several issues with this tip:
- 'currently' is a temporal word — remove it ('If you are unsure which method to use...')
- 'easier' is a comparative that implies simplicity — be specific instead (e.g., 'requires less configuration')
- 'Tip:' is a non-standard callout format for this site. Either use 'Note:' or fold this guidance into the bullet list above as a note on the Firehose option.
What does this PR do? What is the motivation?
TEST BRANCH — for demonstrating the
incorporate-pr-feedbackskill. Do not merge.Updates the Getting Started with AWS integration guide with several changes:
Merge instructions
Merge readiness:
Additional notes
This PR is intentionally written with style issues to demonstrate the
incorporate-pr-feedbackskill's ability to process and apply reviewer comments.