elastic / elastic/beats

[text-auditor] Fix AWS autodiscover EC2/ELB field-description text errors

Open Beginner friendly
#53,148 1 comment 0 reactions 0 assignees View on GitHub
needs_team
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 15m
Merged PRs (30d)
385

Description

## Text Improvements

The following user-facing text issues were found in the repository. Each is a low-effort fix.

### 1. EC2 autodiscover field docs incorrectly describe instances as "listeners"

**File:** `x-pack/libbeat/autodiscover/providers/aws/ec2/_meta/fields.yml` (lines 2, 4, 12)
**Current text:**
- `title: "EC2 Listener"`
- `AWS EC2 Listeners`
- `Represents an AWS EC2 Listener, e.g. state of an EC2.`

**Suggested fix:**
- `title: "EC2 Instance"`
- `AWS EC2 Instances`
- `Represents an AWS EC2 instance, e.g. state of an EC2 instance.`

**Why:** This section documents `aws.ec2` fields (instance architecture, image, subnet, VPC), so referring to EC2 resources as "listeners" is a direct terminology mismatch and can mislead users.

### 2. ELB field description is truncated

**File:** `x-pack/libbeat/autodiscover/providers/aws/elb/_meta/fields.yml` (line 45)
**Current text:** `List of security groups for this`
**Suggested fix:** `List of security groups for this ELB.`
**Why:** The sentence is incomplete and leaves the described object unspecified.

## Suggested Actions

- [ ] Replace the EC2 "Listener" wording family in `x-pack/libbeat/autodiscover/providers/aws/ec2/_meta/fields.yml` with "Instance" wording.
- [ ] Complete the truncated `security_groups` description in `x-pack/libbeat/autodiscover/providers/aws/elb/_meta/fields.yml`.

---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Text Auditor](https://github.com/elastic/beats/actions/runs/34481203132)

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
> - [x] expires on Sep 17, 2026, 1:24 PM UTC

Contributor guide

Open the contributing guide

Research direction

Start with x-pack/libbeat/autodiscover/providers/aws/ec2/_meta/fields.yml at the listed lines and x-pack/libbeat/autodiscover/providers/aws/elb/_meta/fields.yml around line 45. Update the EC2 terminology to describe instances and complete the ELB security-groups sentence; done means both field descriptions match the suggested wording and no "Listener" mismatch remains.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.