Skip to content

Update SNS - First draft of AWS integration edits #3808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 29, 2022
Merged

Update SNS - First draft of AWS integration edits #3808

merged 1 commit into from
Jul 29, 2022

Conversation

ellis-elastic
Copy link
Contributor

@ellis-elastic ellis-elastic commented Jul 22, 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 the AWS 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

@ellis-elastic ellis-elastic added 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 labels Jul 22, 2022
@ellis-elastic ellis-elastic mentioned this pull request Jul 22, 2022
Closed
24 tasks
@elasticmachine
Copy link

💔 Build Failed

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-07-22T12:39:33.784+0000

  • Duration: 12 min 47 sec

Steps errors 2

Expand to view the steps failures

Check integration: aws
  • Took 0 min 3 sec . View more details here
  • Description: ../../build/elastic-package check -v
Google Storage Download
  • Took 0 min 0 sec . View more details here

🤖 GitHub comments

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

  • /test : Re-trigger the build.

@bmorelli25 bmorelli25 changed the base branch from main to aws-doc-updates July 29, 2022 17:56
@bmorelli25 bmorelli25 marked this pull request as ready for review July 29, 2022 17:58
@bmorelli25 bmorelli25 requested a review from a team as a code owner July 29, 2022 17:58
@bmorelli25 bmorelli25 merged commit b5e2b51 into elastic:aws-doc-updates Jul 29, 2022
@elasticmachine
Copy link

💔 Build Failed

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-07-29T17:56:43.673+0000

  • Duration: 11 min 51 sec

Steps errors 2

Expand to view the steps failures

Check integration: aws
  • Took 0 min 3 sec . View more details here
  • Description: ../../build/elastic-package check -v
Google Storage Download
  • Took 0 min 0 sec . View more details here

🤖 GitHub comments

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

  • /test : Re-trigger the build.

bmorelli25 added a commit that referenced this pull request Aug 23, 2022
@bmorelli25 @ellis-elastic
@colleenmcginnis @kaiyan-sheng
AWS integration documentation updates (#3907)
cbb1989 
* Update Readme - First draft of AWS integration edits (#3834)

Added new content based on the new documentation guidelines

* Update WAF - First draft of AWS integration edits (#3833)

Added new content based on the new documentation guidelines.

* Update VPN.MD First draft of AWS integration edits (#3828)

* Update VPN.MD First draft of AWS integration edits

Added new content based on the new documentation guidelines.

* fixed typo

Removed space and duplicated for example

* Update vpcflow,md First draft of AWS integration edits (#3826)

Added new content based on the new documentation guidelines.

* Update AWS Usage - First draft of AWS integration edits (#3824)

* Update AWS Usage - First draft of AWS integration edits

Added new content based on the new documentation guidelines.

* Fixed typo

removed a space

* Update AWS transit gateway - first draft of AWS integration edits (#3810)

added new content based on the new documentation guidelines.

* Update SQS First draft of AWS integration edits (#3809)

Added new content based on the new documentation guidelines.

* Update SNS - First draft of AWS integration edits (#3808)

* Update S3 storage lens- First draft of AWS integration edits (#3806)

* update S3 - first draft of AWS integration edits (#3804)

Added new content based on the new doc guidelines

* Update Route 53 -  First draft of AWS integration edits (#3756)

* update Route 53 -  first draft of AWS integration edits

Added new content based on the new documentation guidelines

* Fixed typo

Added missing full stop

* Update RDS - first draft of AWS integration edits (#3752)

Added new content based on the new documentation guidelines

* Update Nat gateway - first draft of AWS integration edits (#3751)

Added new content based on the new documentation guidelines

* Update Lambda - first draft of AWS integration edits (#3749)

* update Lambda - first draft of AWS integration edits

Added new content based on the new documentation guidelines

* Fix typos in Lambda.md

* Update Network Firewall - added new content based on the new doc guidelines (#3732)

* Update Network Firewall - added new content based on the new documentation guidelines.

* Update Manifest and Changelog

* Ran build

* revert cl/mani

Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* Update ELB - first draft of AWS integration edits (#3656)

* Update ELB - first draft of AWS integration edits

Added new content based on the new documentation guidelines.

* update changelog and manifest

* update elb

ran build

* revert cl/mani

Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* Update EC2 - first draft of AWS integration edits (#3638)

* Update EC2 - first draft of AWS integration edits

Added new content based on the new documentation guidelines.

* Update Changelog and Manifest

* update ec2.md

ran build

* Update packages/aws/_dev/build/docs/ec2.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ec2.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ec2.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ec2.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ec2.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* revert cl/mani

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* Update EBS- first draft of AWS integration edits (#3634)

* Update EBS- first draft of AWS integration edits

Added new content based on the new documentation guidelines.

* Update Changelog and Manifest

* Ran elastic-pacakge build

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* revert cl/mani

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* Update DynamoDB- first draft of AWS integration edits (#3633)

* Update Dynamodb - first draft of aws integration edits

Added new content based on the new documentation guidelines.

* Update Changelog and Manifest

* Ran build, updated changelog and manifest

* Update packages/aws/_dev/build/docs/dynamodb.md

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

* Update dynamoDB

Re worded the example para in light of reviewers comments

* Ran elastic package build

* revert cl/mani

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* Update CloudTrail - First draft of AWS integration edits (#3611)

* Update CloudTrail - first draft of aws integration edits

Added new content based on the new documentation guidelines.

* Update CouldTrail - fixed typo

Changed Cloudtrail to CloudTrail

* Update Changelog and manifest

* Ran Build

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Updated note section

Updated note section in light on Coleen's comments

* Re ran build

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

* Update packages/aws/_dev/build/docs/cloudtrail.md

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

* revert cl/mani

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* Update Billing.md (#3584)

* update Billing.md

 added new content based on the new documentation guidelines.

* Update Changelog, manifest and ran build

* Revert "Update Changelog, manifest and ran build"

This reverts commit c0fda79.

* Update changelog and manifest

* Update Billing.md

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Revert "Update Billing.md"

This reverts commit 3868827.

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* update billing

added details on the metrics collected

* update billing

ran build

* fix changelog formatting

* Update packages/aws/_dev/build/docs/billing.md

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

* Update packages/aws/docs/billing.md

Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co>

* Update Billing.md

Removed overview heading

* Update changelog and ran build

* Update Billing

Fixed duplicated word

* revert cl/mani

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co>
Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>

* get it passing ci

* update docs

* Revert "Update Readme - First draft of AWS integration edits (#3834)"

This reverts commit 76eaca3.

* Update packages/aws/_dev/build/docs/natgateway.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/vpcflow.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/vpcflow.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/waf.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/vpcflow.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/s3.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/rds.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Update packages/aws/_dev/build/docs/elb.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* Apply suggestions from code review

* Update packages/aws/_dev/build/docs/ebs.md

* Update packages/aws/_dev/build/docs/ec2.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* feedback

* feedback

* Apply suggestions from code review

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* feedback

* `elastic-package build`

* Update packages/aws/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

* `elastic-package build`

* docs: address feedback

* `elastic-package build`

* address more feedback

* more feedback

* address feedback

Co-authored-by: Ellis Pratt <103435263+ellis-elastic@users.noreply.github.com>
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co>
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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.
4 participants
@ellis-elastic @elasticmachine @bmorelli25 @colleenmcginnis