elastic / elastic/docs-content

Docs fix — style: path /deploy-manage/deploy/cloud-on-k8s — 94 pages

Open
#6,902 0 comments 0 reactions 0 assignees View on GitHub
docs-fix:style docs-quality-sweep
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

Generated by `gh-aw-docs-style-sweep` for `elastic/docs-content` on 2026-W24.

Path /deploy-manage/deploy/cloud-on-k8s · 94 total in scope · subtree corpus 94 pages.

## Findings (20)

```yaml
- file: deploy-manage/deploy/cloud-on-k8s/advanced-configuration-maps-server.md
line: 64
category: word-choice
severity: medium
evidence: "'just a matter of' — Elastic.DontUse rule"
suggested_fix: |
scaling out is a matter of increasing the `count` attribute

- file: deploy-manage/deploy/cloud-on-k8s/advanced-elasticsearch-node-scheduling.md
line: 329
category: accessibility
severity: medium
evidence: "'described below' — Elastic.DirectionalLanguage rule"
suggested_fix: |
the following two steps

- file: deploy-manage/deploy/cloud-on-k8s/configure-validating-webhook.md
line: 82
category: word-choice
severity: medium
evidence: "'you have just created' — Elastic.DontUse rule"
suggested_fix: |
the secret you created

- file: deploy-manage/deploy/cloud-on-k8s/configure-validating-webhook.md
line: 211
category: word-choice
severity: medium
evidence: "'restricts webhook access to just the API server' — Elastic.DontUse rule"
suggested_fix: |
the following policy restricts webhook access to the API server only

- file: deploy-manage/deploy/cloud-on-k8s/deploy-eck-on-gke-autopilot.md
line: 118
category: word-choice
severity: medium
evidence: "'and/or' in heading — Elastic.DontUse rule"
suggested_fix: |
Deploy a standalone Elastic Agent, Beats, or both

- file: deploy-manage/deploy/cloud-on-k8s/deploy-eck-on-gke-autopilot.md
line: 122
category: word-choice
severity: medium
evidence: "'Elastic Agent and/or Beats within GKE Autopilot' — Elastic.DontUse rule"
suggested_fix: |
Elastic Agent, Beats, or both within GKE Autopilot

- file: deploy-manage/deploy/cloud-on-k8s/deploy-elastic-maps-server.md
line: 43
category: word-choice
severity: medium
evidence: "'and thus access' — Elastic.DontUse rule"
suggested_fix: |
can reference and access any {{es}} instance

- file: deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
line: 354
category: grammar
severity: medium
evidence: "\"Applying\", and \"Ready\", — punctuation outside closing quotation marks — Elastic.QuotesPunctuation rule"
suggested_fix: |
in which phase the policy is ("Applying," "Ready," "Error")

- file: deploy-manage/deploy/cloud-on-k8s/install.md
line: 23
category: word-choice
severity: medium
evidence: "'e.g.' — Elastic.Latinisms rule"
suggested_fix: |
for example

- file: deploy-manage/deploy/cloud-on-k8s/k8s-kibana-es.md
line: 17
category: word-choice
severity: medium
evidence: "'quite straightforward' — Elastic.DontUse rule"
suggested_fix: |
It is straightforward to connect a {{kib}} instance to an {{es}} cluster managed by ECK

- file: deploy-manage/deploy/cloud-on-k8s/k8s-openshift-deploy-operator.md
line: 34
category: word-choice
severity: medium
evidence: "'etc' — Elastic.Latinisms rule"
suggested_fix: |
(default, kube-\*, openshift-\*, and so on)

- file: deploy-manage/deploy/cloud-on-k8s/k8s-service-mesh-istio.md
line: 52
category: accessibility
severity: medium
evidence: "'the above command' — Elastic.DirectionalLanguage rule"
suggested_fix: |
the output of the preceding command

- file: deploy-manage/deploy/cloud-on-k8s/k8s-service-mesh-linkerd.md
line: 35
category: accessibility
severity: medium
evidence: "'the above command' — Elastic.DirectionalLanguage rule"
suggested_fix: |
the output of the preceding command

- file: deploy-manage/deploy/cloud-on-k8s/known-limitations.md
line: 20
category: formatting
severity: medium
evidence: "heading ends with period: '## {{agent}} running in the same namespace as the {{stack}}.' — Elastic.EndPuntuaction rule"
suggested_fix: |
## {{agent}} running in the same namespace as the {{stack}} [k8s_agent_running_in_the_same_namespace_as_the_stack]

- file: deploy-manage/deploy/cloud-on-k8s/logstash-plugins.md
line: 95
category: grammar
severity: medium
evidence: "'a SQL statement' — Elastic.Articles rule; 'SQL' is initialised as 'ess-cue-ell', so article should be 'an'"
suggested_fix: |
an SQL statement

- file: deploy-manage/deploy/cloud-on-k8s/logstash-plugins.md
line: 244
category: word-choice
severity: medium
evidence: "'or just to actually write events' — Elastic.DontUse rule"
suggested_fix: |
or to write events to disk

- file: deploy-manage/deploy/cloud-on-k8s/nodes-orchestration.md
line: 191
category: grammar
severity: medium
evidence: "'deems it to be \"unsafe\".' — period outside closing quotation mark — Elastic.QuotesPunctuation rule"
suggested_fix: |
it deems it to be "unsafe."

- file: deploy-manage/deploy/cloud-on-k8s/pod-prestop-hook.md
line: 20
category: word-choice
severity: medium
evidence: "'resolved just before DNS record was updated' — Elastic.DontUse rule"
suggested_fix: |
the terminating Pod IP resolved immediately before the DNS record was updated

- file: deploy-manage/deploy/cloud-on-k8s/propagate-labels-annotations.md
line: 13
category: accessibility
severity: medium
evidence: "'The example below demonstrates' — Elastic.DirectionalLanguage rule"
suggested_fix: |
The following example demonstrates

- file: deploy-manage/deploy/cloud-on-k8s/webhook-namespace-selectors.md
line: 17
category: word-choice
severity: medium
evidence: "'not just the set of namespaces' — Elastic.DontUse rule"
suggested_fix: |
the whole cluster and not only the set of namespaces it is configured to manage
```

## Done when
- All listed lines pass the Elastic style guide rules cited.
- A PR addressing this issue is merged.

## Notes
- `Elastic.MappedPages` findings (86) and first-person matches in example strings (e.g., `my.registry` placeholder values) were excluded as false positives. Low-severity (`suggestion`) findings omitted; only `warning`-level findings included.

> Generated by [Docs style sweep agent](https://github.com/elastic/docs-content/actions/runs/27336204463) · 228.2 AIC · ⌖ 13.4 AIC · ⊞ 26.6K · [◷](https://github.com/search?q=repo%3Aelastic%2Fdocs-content+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fdocs-content%2Fgh-aw-docs-style-sweep%22&type=issues)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.