Skip to content

First draft of CloudWatch edits#3614

Closed
ginny-elastic wants to merge 10 commits intoelastic:mainfrom
ginny-elastic:aws-cloudwatch-docs
Closed

First draft of CloudWatch edits#3614
ginny-elastic wants to merge 10 commits intoelastic:mainfrom
ginny-elastic:aws-cloudwatch-docs

Conversation

@ginny-elastic
Copy link
Copy Markdown

@ginny-elastic ginny-elastic commented Jun 28, 2022 •
edited
Loading

What does this PR do?

From #3572:

In #3308 we updated docs for two AWS integrations to align with the new documentation guidelines and establish the relationship between the AWS integration/package ("AWS") and integrations for individual AWS services (for example, "AWS CloudFront").

Now we should update the docs for all AWS integrations for individual services to follow the same format as the updated "AWS CloudFront" integration docs.

This PR adds more context for the AWS CloudWatch integration including:

  • Adds context to the "Overview" including a link to the relevant AWS page and an example
  • Lists the types of "Data streams" for the service
  • "Requirements" points back to "AWS" for detailed information on credentials and permissions
  • "Requirements" includes any other service-specific requirements
  • "Setup" establishes a relationship between the AWS integration/package ("AWS") and this integration
  • Includes "Reference" sections

For the reviewer

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • Review by docs team
  • Review by integrations team

Related issues

@ginny-elastic
First draft of CloudWatch edits
c6dc5cf 
Added new content based on the new documentation guidelines.
@ginny-elastic ginny-elastic requested a review from a team as a code owner June 28, 2022 14:15
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Jun 28, 2022 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-28T14:24:00.762+0000

  • Duration: 37 min 21 sec

Test stats 🧪

Test Results
Failed 0
Passed 332
Skipped 0
Total 332

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@colleenmcginnis colleenmcginnis requested a review from a team June 28, 2022 14:36
@colleenmcginnis colleenmcginnis self-assigned this Jun 28, 2022
@colleenmcginnis colleenmcginnis added enhancement New feature or request documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Team:Docs Label for the Observability docs team labels Jun 28, 2022
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Jun 28, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (11/11) 💚
Files 91.667% (11/12) 👎 -4.924
Classes 91.667% (11/12) 👎 -4.924
Methods 82.692% (172/208) 👎 -6.128
Lines 92.673% (2087/2252) 👍 2.737
Conditionals 100.0% (0/0) 💚

colleenmcginnis
colleenmcginnis reviewed Jun 28, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ginny-elastic! I left some suggestions below. We'll also want the development team responsible for this integration to weigh in.

@colleenmcginnis colleenmcginnis mentioned this pull request Jun 28, 2022
Closed
24 tasks
@bmorelli25 bmorelli25 marked this pull request as draft June 30, 2022 19:14
bmorelli25
bmorelli25 reviewed Jun 30, 2022
View reviewed changes
packages/aws/_dev/build/docs/cloudwatch.md Outdated
## Logs
## Overview

The AWS CloudWatch integration allows you to monitor [AWS CloudWatch](https://aws.amazon.com/cloudwatch/). AWS CloudWatch is a monitoring and observability service built for DevOps engineers, developers, site reliability engineers (SREs), IT managers, and product owners. CloudWatch provides you with data and actionable insights to monitor your applications, respond to system-wide performance changes, and optimize resource utilization.
Copy link
Copy Markdown
Member

@bmorelli25 bmorelli25 Jun 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm concerned that this is copy/pasted from https://aws.amazon.com/cloudwatch/. Can we say this in our own words instead?

Copy link
Copy Markdown

@dedemorton dedemorton Jun 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We must say this in our own words. @ginny-elastic Can you let us know if you copied this text from some Elastic resource or text provided in a spec? We need to make sure folks understand that copying text without permission from the author or company is not OK. I haven't looked at the AWS copyright statement, but I'm pretty sure this text is not fair game for our docs.

Copy link
Copy Markdown

@dedemorton dedemorton Jun 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is protected: https://aws.amazon.com/terms/

Copy link
Copy Markdown
Author

@ginny-elastic ginny-elastic Jul 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will re-word.

Copy link
Copy Markdown
Author

@ginny-elastic ginny-elastic Jul 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have re-worded it.

ginny-elastic and others added 7 commits July 6, 2022 13:51
@ginny-elastic @colleenmcginnis
Update packages/aws/_dev/build/docs/cloudwatch.md
f7d0e32 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@ginny-elastic @colleenmcginnis
Update packages/aws/_dev/build/docs/cloudwatch.md
5577016 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@ginny-elastic @colleenmcginnis
Update packages/aws/_dev/build/docs/cloudwatch.md
945efac 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@ginny-elastic @colleenmcginnis
Update packages/aws/_dev/build/docs/cloudwatch.md
1be2d28 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@ginny-elastic @colleenmcginnis
Update packages/aws/_dev/build/docs/cloudwatch.md
0034ecd 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@ginny-elastic
Update cloudwatch.md
cbfc33e 
Edited description of the service so it is in our own words.
@ginny-elastic
update cloudwatch.md
6b6be15 
Ran elastic package build.
@bmorelli25
Copy link
Copy Markdown
Member

bmorelli25 commented Jul 29, 2022

Replaced by #3907.

@bmorelli25 bmorelli25 closed this Jul 29, 2022
@github-actions github-actions bot mentioned this pull request Mar 27, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bmorelli25 bmorelli25 bmorelli25 left review comments

+2 more reviewers

@colleenmcginnis colleenmcginnis colleenmcginnis left review comments

@dedemorton dedemorton dedemorton left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@colleenmcginnis colleenmcginnis

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Team:Docs Label for the Observability docs team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ginny-elastic @elasticmachine @bmorelli25 @colleenmcginnis @dedemorton