elastic / elastic/beats

[text-auditor] Fix clear user-facing typo and GCS terminology mismatch in docs/config text

Open Beginner friendly
#51,216 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. Possessive typo in logging reference template propagates broadly

**File:** `libbeat/_meta/config/logging.reference.yml.tmpl` (line 77)
**Current text:** `# default logger, but it will have it's own file configuration.`
**Suggested fix:** `# default logger, but it will have its own file configuration.`
**Why:** Clear typo (`it's` vs possessive `its`) in user-facing reference text.

**Completeness pass:** searching for `have it's own file configuration\.` finds 20 occurrences (the source template plus generated reference/docs copies), including:
- `auditbeat/auditbeat.reference.yml:1565`
- `filebeat/filebeat.reference.yml:2823`
- `heartbeat/heartbeat.reference.yml:1648`
- `metricbeat/metricbeat.reference.yml:2533`
- `packetbeat/packetbeat.reference.yml:2033`
- `winlogbeat/winlogbeat.reference.yml:1441`
- `docs/reference/filebeat/filebeat-reference-yml.md:2766`

### 2. GCS input docs use wrong resource term (`Container`) at bucket scope

**File:** `docs/reference/filebeat/filebeat-input-gcs.md` (lines 394, 432)
**Current text:** `...You can define these attributes at the \`root\` or \`bucket\` level in the configuration. Container level definitions always take precedence.`
**Suggested fix:** `...You can define these attributes at the \`root\` or \`bucket\` level in the configuration. Bucket level definitions always take precedence.`
**Why:** Direct terminology mismatch/clarity issue in user-facing docs.

**Behavior evidence:** GCS input config is bucket-based (`x-pack/filebeat/input/gcs/config.go:61-63` defines `Buckets []bucket `config:"buckets"``), so `Container` is inconsistent for this input.

**Completeness pass:** searching `Container level definitions always take precedence\.` in `docs/reference/filebeat` returns 4 occurrences; only the two GCS lines are mismatches. The 2 Azure Blob occurrences (`filebeat-input-azure-blob-storage.md:390,429`) are correct for container terminology.

## Suggested Actions

- [ ] Update `libbeat/_meta/config/logging.reference.yml.tmpl` line 77 (`it's` → `its`) and regenerate affected reference docs/config artifacts.
- [ ] Update `docs/reference/filebeat/filebeat-input-gcs.md` lines 394 and 432 (`Container level` → `Bucket level`).

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

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
> - [x] expires on Jun 19, 2026, 2:15 PM UTC

Contributor guide

Open the contributing guide

Research direction

Start with libbeat/_meta/config/logging.reference.yml.tmpl and docs/reference/filebeat/filebeat-input-gcs.md, then search for both specified phrases to identify generated copies and confirm the Azure Blob wording is unchanged. Regenerate the affected reference artifacts, update the two GCS occurrences, and verify that the typo and terminology mismatch no longer appear in the relevant files.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud
Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.