Skip to content

[text-auditor] Batch fix clear user-facing config and Kubernetes docs text errors #14748

@github-actions

Description

@github-actions

Text Improvements

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

1. agent.process timeout comments contain repeated grammar/wording errors

These comments are repeated in templates and generated config references.

1.1 Spawn timeout sentence is grammatically broken

Current text: # # timeout for creating new processes. when process is not successfully created by this timeout
Suggested fix: # # timeout for creating new processes. If a process is not successfully created within this timeout

Verified occurrences:

  • elastic-agent.reference.yml (line 147)
  • elastic-agent.yml (line 206)
  • elastic-agent.docker.yml (line 87)
  • _meta/elastic-agent.yml (line 94)
  • _meta/elastic-agent.fleet.yml (line 25)
  • _meta/config/common.reference.p2.yml.tmpl (line 141)
  • _meta/config/common.p2.yml.tmpl (line 200)
  • _meta/config/elastic-agent.docker.yml.tmpl (line 87)

Why: Clear grammar errors (missing article, sentence casing, awkward phrasing) in user-facing config guidance.

1.2 Stop timeout sentence is grammatically broken

Current text: # # timeout for stopping processes. when process is not stopped by this timeout then the process.
Suggested fix: # # timeout for stopping processes. If a process is not stopped within this timeout, the process

Verified occurrences:

  • elastic-agent.reference.yml (line 150)
  • elastic-agent.yml (line 209)
  • elastic-agent.docker.yml (line 90)
  • _meta/config/common.reference.p2.yml.tmpl (line 144)
  • _meta/config/common.p2.yml.tmpl (line 203)
  • _meta/config/elastic-agent.docker.yml.tmpl (line 90)

Why: Clear grammar and sentence-structure errors in user-facing comments.

1.3 Incorrect phrase is force killed

Current text: # # is force killed
Suggested fix: # # is forcibly killed

Verified occurrences:

  • elastic-agent.reference.yml (line 151)
  • elastic-agent.yml (line 210)
  • elastic-agent.docker.yml (line 91)
  • _meta/config/common.reference.p2.yml.tmpl (line 145)
  • _meta/config/common.p2.yml.tmpl (line 204)
  • _meta/config/elastic-agent.docker.yml.tmpl (line 91)

Why: force killed is an unambiguous wording error.

2. Kubernetes/Helm docs include clear typo families

2.1 Misspelling: utlilizing

File: deploy/helm/edot-collector/kube-stack/README.md (line 16)
Current text: ... on each node, utlilizing [kubeletstats] ...
Suggested fix: ... on each node, utilizing [kubeletstats] ...
Why: Clear spelling typo.

2.2 Duplicate word: File Log Receiver receiver

File: deploy/helm/edot-collector/kube-stack/README.md (line 17)
Current text: Utilizes [File Log Receiver receiver] ...
Suggested fix: Utilizes the [File Log Receiver] ...
Why: Unambiguous duplicate-word grammar issue.

2.3 KSM typoed as KMS in autosharding description

File: deploy/kubernetes/README.md (line 23)
Current text: ... setup with KMS in autosharding configuration
Suggested fix: ... setup with KSM in autosharding configuration
Why: Clear terminology typo; adjacent text is explicitly about kube-state-metrics (KSM).

2.4 Misspelling: Statefuleset

Verified occurrences:

  • deploy/kubernetes/README.md (line 50)
  • docs/elastic-agent-ksm-sharding.md (line 76)

Current text: Statefuleset
Suggested fix: StatefulSet
Why: Clear misspelling of Kubernetes resource name.

Suggested Actions

  • Fix the agent.process timeout comment text in _meta/config/*.tmpl and corresponding surfaced config files.
  • Correct utlilizing and File Log Receiver receiver in deploy/helm/edot-collector/kube-stack/README.md.
  • Replace KMS with KSM in deploy/kubernetes/README.md autosharding row.
  • Replace Statefuleset with StatefulSet in all listed docs occurrences.

What is this? | From workflow: Text Auditor

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Jun 10, 2026, 2:43 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions