elastic / elastic/beats

[text-auditor] Fix a few clear user-facing text typos in docs and field descriptions

Open
#49,352 1 comment 0 reactions 0 assignees View on GitHub
needs_team
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 2h
Merged PRs (30d)
364

Description

## Text Improvements

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

### 1. Typo in Etcd metric field description

**File:** `metricbeat/module/etcd/metrics/_meta/fields.yml` (line 20)
**Current text:** `Number of consensus proposals commited`
**Suggested fix:** `Number of consensus proposals committed`
**Why:** Clear spelling typo in exported field text.

### 2. Grammar typo in testing environment instructions

**File:** `testing/environments/README.md` (line 25)
**Current text:** `To stop an clean up the environment afterwards, make sure to run:`
**Suggested fix:** `To stop and clean up the environment afterwards, make sure to run:`
**Why:** Clear grammar typo (`an` vs `and`) in user-facing instructions.

### 3. Typo in cleanup warning text

**File:** `testing/environments/README.md` (line 52)
**Current text:** `...this will stop ALL docker containers ony our docker-machine.`
**Suggested fix:** `...this will stop ALL docker containers on your docker-machine.`
**Why:** Clear typo (`ony`) and incorrect word (`our`) in user-facing warning text.

### 4. Grammar typo in notes section

**File:** `testing/environments/README.md` (line 61)
**Current text:** `...before starting an other environment.`
**Suggested fix:** `...before starting another environment.`
**Why:** Clear grammar typo in user-facing documentation.

## Suggested Actions

- [ ] Replace `commited` with `committed` in `metricbeat/module/etcd/metrics/_meta/fields.yml`.
- [ ] Replace `an` with `and` in `testing/environments/README.md` line 25.
- [ ] Replace `ony our` with `on your` in `testing/environments/README.md` line 52.
- [ ] Replace `an other` with `another` in `testing/environments/README.md` line 61.

Duplicate check performed against `/tmp/previous-findings.json` and current open issues; no matching open issue was found for these exact strings.

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

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.