Skip to content

Conversation

austinsonger
Copy link
Contributor

The 3rd section was ## and should have been ###

@austinsonger austinsonger marked this pull request as ready for review March 22, 2023 20:38
@austinsonger austinsonger requested a review from a team as a code owner March 22, 2023 20:38
@elasticmachine
Copy link

elasticmachine commented Mar 22, 2023

💚 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: 2023-03-24T11:38:27.694+0000

  • Duration: 52 min 36 sec

Test stats 🧪

Test Results
Failed 0
Passed 188
Skipped 4
Total 192

🤖 GitHub comments

Expand to view the GitHub comments

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

  • /test : Re-trigger the build.

@zmoog
Copy link
Contributor

zmoog commented Mar 23, 2023

Hey @austinsonger, thank you for this fix! I just pushed a minor change to the PR.

Integrations docs are stored in two places:

  • packages/NAME/_dev/build/docs in source form.
  • packages/NAME/docs in the rendered form.

Any change to the docs should be made on the source form at packages/NAME/_dev/build/docs.

After the change is made, we must build the rendered version using the elastic-package tool:

$ elastic-package build 
Build the package
README.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/README.md
billing.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/billing.md
cloudfront.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/cloudfront.md
cloudtrail.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/cloudtrail.md
cloudwatch.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/cloudwatch.md
dynamodb.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/dynamodb.md
ebs.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/ebs.md
ec2.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/ec2.md
ecs.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/ecs.md
elb.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/elb.md
firewall.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/firewall.md
guardduty.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/guardduty.md
inspector.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/inspector.md
kinesis.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/kinesis.md
lambda.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/lambda.md
natgateway.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/natgateway.md
rds.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/rds.md
redshift.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/redshift.md
route53.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/route53.md
s3.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/s3.md
s3_storage_lens.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/s3_storage_lens.md
securityhub.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/securityhub.md
sns.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/sns.md
sqs.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/sqs.md
transitgateway.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/transitgateway.md
usage.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/usage.md
vpcflow.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/vpcflow.md
vpn.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/vpn.md
waf.md file rendered: /Users/zmoog/code/projects/elastic/integrations/packages/aws/docs/waf.md
2023/03/23 16:31:45  INFO License text found in "/Users/zmoog/code/projects/elastic/integrations/LICENSE.txt" will be included in package
Package built: /Users/zmoog/code/projects/elastic/integrations/build/packages/aws-1.32.1.zip
Done

@zmoog
Copy link
Contributor

zmoog commented Mar 23, 2023

We should document this process if it still needs to be done.

@elasticmachine
Copy link

elasticmachine commented Mar 23, 2023

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (15/15) 💚
Files 93.75% (15/16) 👎 -6.25
Classes 93.75% (15/16) 👎 -6.25
Methods 86.131% (236/274) 👍 52.798
Lines 85.925% (7387/8597) 👎 -14.075
Conditionals 100.0% (0/0) 💚

@zmoog zmoog merged commit da21875 into elastic:main Mar 24, 2023
@elasticmachine
Copy link

Package aws - 1.32.2 containing this change is available at https://epr.elastic.co/search?package=aws

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants