Skip to content

Update AWS Fargate - first draft of AWS integration edits#3730

Closed
ellis-elastic wants to merge 5 commits intoelastic:aws-doc-updatesfrom
ellis-elastic:AWS-Fargate
Closed

Update AWS Fargate - first draft of AWS integration edits#3730
ellis-elastic wants to merge 5 commits intoelastic:aws-doc-updatesfrom
ellis-elastic:AWS-Fargate

Conversation

@ellis-elastic
Copy link
Copy Markdown
Contributor

@ellis-elastic ellis-elastic commented Jul 18, 2022

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

Added new content based on the new documentation guidelines.
@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 18, 2022
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Jul 18, 2022

💔 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-08-09T15:42:09.387+0000

  • Duration: 10 min 50 sec

Steps errors 2

Expand to view the steps failures

Check integration: awsfargate
  • Took 0 min 1 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.

@elasticmachine
Copy link
Copy Markdown

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (0/0) 💚
Files 100.0% (0/0) 💚 3.043
Classes 100.0% (0/0) 💚 3.043
Methods 66.667% (2/3) 👎 -22.414
Lines 100.0% (0/0) 💚 9.827
Conditionals 100.0% (0/0) 💚

@bmorelli25 bmorelli25 changed the base branch from main to aws-doc-updates July 29, 2022 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants