[CL] Improve integration documentation

[bmorelli25]

Get started

• [ ] Install elastic-package. You may need to install it with Go.
• [ ] Checkout the elastic/integrations repository
• [ ] cd into a package in the integrations repo and build your first package.

Update a package

• [ ] Update a package. Instructions below.

• Work should be completed in the */_dev/build/docs/README.md file. Here’s an example.

• After the readme file has been updated, the package version needs to be bumped and a changelog entry needs to be added. Changelogs are bumped in the package’s changelog.yml file. A patch bump should be sufficient. Here’s an example.

• Build the docs. The elastic/package tool builds each integration’s readme file. Install the tool then run elastic-package build to update a package’s readme file.

• Open a PR in elastic/integrations.

Package checklist

Review the documentation for the following packages:

• [ ] 1Password Events Reporting
• [ ] AbuseCH
• [ ] ActiveMQ
• [ ] Akamai
• [ ] AlienVault OTX
• [ ] Anomali
• [ ] Apache HTTP Server
• [ ] Apache Tomcat
• [ ] Arbor Peakflow SP Logs
• [ ] Atlassian Bitbucket
• [ ] Atlassian Confluence
• [ ] Atlassian Jira
• [ ] Auditd
• [ ] Auth0 Log Streams Integration
• [ ] AWS
• [ ] AWS Billing Metrics
• [ ] AWS CloudFront
• [ ] AWS Cloudtrail Logs
• [ ] AWS CloudWatch
• [ ] AWS DynamoDB Metrics
• [ ] AWS EBS Metrics
• [ ] AWS EC2
• [ ] AWS ELB
• [ ] AWS Lambda Metrics
• [ ] AWS NAT Gateway Metrics
• [ ] AWS Network Firewall
• [ ] AWS RDS Metrics
• [ ] AWS Route 53
• [ ] AWS S3
• [ ] AWS S3 Storage Lens
• [ ] AWS SNS Metrics
• [ ] AWS SQS Metrics
• [ ] AWS Transit Gateway Metrics
• [ ] AWS Usage Metrics
• [ ] AWS VPC Flow Logs
• [ ] AWS VPN Metrics
• [ ] AWS WAF Logs
• [ ] Azure Active Directory logs
• [ ] Azure activity logs
• [ ] Azure Application Insights Metrics
• [ ] Azure Application Insights Metrics Overview
• [ ] Azure Application State Insights Metrics
• [ ] Azure Billing Metrics
• [ ] Azure Container Instance Metrics
• [ ] Azure Container Registry Metrics
• [ ] Azure Container Service Metrics
• [ ] Azure Database Account Metrics
• [ ] Azure Event Hub Input
• [ ] Azure Logs
• [ ] Azure Monitor Metrics
• [ ] Azure platform logs
• [ ] Azure Resource Metrics
• [ ] Azure Spring Cloud logs
• [ ] Azure Storage Account Metrics
• [ ] Azure Virtual Machines Metrics
• [ ] Azure Virtual Machines Scaleset Metrics
• [ ] Barracuda Logs
• [ ] Blue Coat Director Logs
• [ ] Cassandra
• [ ] CEF Logs
• [ ] Check Point
• [ ] Cisco
• [ ] Cisco ASA
• [ ] Cisco Duo
• [ ] Cisco FTD
• [ ] Cisco IOS
• [ ] Cisco Meraki
• [ ] Cisco Nexus
• [ ] Cisco Secure Endpoint (AMP)
• [ ] Cisco Umbrella
• [ ] Cloudflare
• [ ] CockroachDB Metrics
• [ ] CrowdStrike Logs
• [ ] Custom HTTP Endpoint Logs
• [ ] Custom HTTPJSON Input
• [ ] Custom Journald logs
• [ ] Custom Logs
• [ ] Custom TCP Logs
• [ ] Custom UDP Logs
• [ ] Custom Windows Event Logs
• [ ] CyberArk Privileged Access Security Logs
• [ ] Cybersixgill
• [ ] CylanceProtect Logs
• [ ] Docker Metrics
• [ ] Elastic Agent
• [ ] Elastic APM
• [ ] Elastic Synthetics
• [ ] Elasticsearch
• [ ] Endpoint Security
• [ ] F5 Logs
• [ ] Fireeye
• [ ] Fleet Server
• [ ] Fortinet Logs
• [ ] GitHub
• [ ] Google Cloud Platform
• [ ] Google Santa Logs
• [ ] Google Workspace Audit Reports
• [ ] HAProxy
• [ ] Hashicorp Vault
• [ ] Hitachi ID Bravura Monitor
• [ ] IIS
• [ ] Imperva SecureSphere Logs
• [ ] Infoblox NIOS Logs
• [ ] Iptables Logs
• [ ] Juniper JunOS
• [ ] Juniper Logs
• [ ] Juniper NetScreen
• [ ] Juniper SRX
• [ ] Kafka
• [ ] Keycloak
• [ ] Kibana
• [ ] Kube-apiserver Metrics
• [ ] Kube-controller-manager Metrics
• [ ] Kube-proxy Metrics
• [ ] Kube-scheduler Metrics
• [ ] Kube-state-metrics
• [ ] Kubelet Metrics
• [ ] Kubernetes
• [ ] Kubernetes Audit Logs
• [ ] Kubernetes Container Logs
• [ ] Kubernetes Event Metrics
• [ ] Linux Metrics
• [ ] Logstash
• [ ] Mattermost
• [ ] Microsoft
• [ ] Microsoft Defender for Endpoint
• [ ] Microsoft DHCP
• [ ] Microsoft SQL Server
• [ ] MISP
• [ ] ModSecurity Audit
• [ ] MongoDB
• [ ] MySQL
• [ ] MySQL Enterprise
• [ ] NATS
• [ ] NetFlow Records
• [ ] Netskope
• [ ] Network Packet Capture
• [ ] Nginx
• [ ] Nginx Ingress Controller Logs
• [ ] Office 365 Logs
• [ ] Okta Logs
• [ ] Oracle
• [ ] Osquery Logs
• [ ] Osquery Manager
• [ ] Palo Alto Cortex XDR Logs
• [ ] Palo Alto Networks Logs
• [ ] pfSense Logs
• [ ] PostgreSQL
• [ ] Prebuilt Security Detection Rules
• [ ] Prometheus Metrics
• [ ] Proofpoint Email Security Logs
• [ ] Pulse Connect Secure
• [ ] QNAP NAS
• [ ] RabbitMQ Logs
• [ ] Radware DefensePro Logs
• [ ] Redis
• [ ] Snort
• [ ] Snyk
• [ ] Sonicwall-FW Logs
• [ ] Sophos Logs
• [ ] Squid Logs
• [ ] STAN
• [ ] Suricata Events
• [ ] Symantec Endpoint Protection
• [ ] System
• [ ] Tenable.sc
• [ ] ThreatQuotient
• [ ] Traefik
• [ ] VMware Carbon Black EDR
• [ ] VMware vSphere
• [ ] Windows
• [ ] Zeek Logs
• [ ] ZeroFox
• [ ] ZooKeeper Metrics
• [ ] Zoom
• [ ] Zscaler Internet Access
• [ ] Zscaler Private Access

Guidelines and examples

Structure

Integrations should...

• Start with an H1.
  • Good
  • Bad
• Use markdown syntax for everything: links, lists, code snippets, code blocks, bold/italics/underline, and headings.
• Link to the thing they’re integrating with.
  • Good: https://docs.elastic.co/en/integrations/santa
  • Bad: https://docs.elastic.co/en/integrations/okta
• Every topic should have at least a 1-2 line overview paragraph, even if it’s a little repetitive. This overview should link to relevant content.
  • Good
  • Bad -- this, for example, could explain what transit gateway is and link to the AWS documentation

Examples

• Bad example: Azure Metrics
  • Needs links in markdown format
  • Needs an unordered list for required credentials

Bad example: Hashicorp

• Needs to use code snippets for long file paths and socket addresses ``

[bmorelli25]

This is done.