Skip to content

Docs fix — page openings: path /deploy-manage/deploy/cloud-on-k8s — 13 pages #6905

@github-actions

Description

@github-actions

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

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

Findings (13)

- file: deploy-manage/deploy/cloud-on-k8s/eck-gdch.md
  line: 9
  category: missing-h1-anchor
  severity: high
  evidence: "H1 '# Deploy ECK on Google Distributed Cloud air-gapped' has no [anchor-id] suffix; every sibling page in this directory uses the [anchor] convention"
  suggested_fix: |
    # Deploy ECK on Google Distributed Cloud air-gapped [k8s-eck-gdch]

- file: deploy-manage/deploy/cloud-on-k8s/manage-deployments.md
  line: 17
  category: missing-h1-anchor
  severity: high
  evidence: "H1 '# Manage deployments in {{eck}}' has no [anchor-id] suffix; all peer pages carry anchors"
  suggested_fix: |
    # Manage deployments in {{eck}} [k8s-manage-deployments]

- file: deploy-manage/deploy/cloud-on-k8s/orchestrate-other-elastic-applications.md
  line: 12
  category: missing-h1-anchor
  severity: high
  evidence: "H1 '# Orchestrate other Elastic applications' has no [anchor-id] suffix; all peer pages carry anchors"
  suggested_fix: |
    # Orchestrate other Elastic applications [k8s-orchestrate-other-elastic-applications]

- file: deploy-manage/deploy/cloud-on-k8s/tools-apis.md
  line: 10
  category: missing-h1-anchor
  severity: high
  evidence: "H1 '# Tools and APIs for {{eck}}' has no [anchor-id] suffix; all peer pages carry anchors"
  suggested_fix: |
    # Tools and APIs for {{eck}} [k8s-tools-apis]

- file: deploy-manage/deploy/cloud-on-k8s/apm-server.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "Opening is a single sentence ('This section describes how to deploy, configure and access an APM Server with ECK.') that does not define what APM Server is, explain its purpose, or state its value — required for an overview/landing page"
  suggested_fix: |
    APM Server receives performance data from APM agents running in your applications and forwards it to Elasticsearch. When deployed with ECK, APM Server integrates automatically with your ECK-managed Elasticsearch and Kibana instances through secure, certificate-based connections. This section describes how to deploy, configure, and access APM Server on ECK.

- file: deploy-manage/deploy/cloud-on-k8s/beats.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "Opening is a single sentence ('This section describes how to configure and deploy Beats with ECK.') that does not define Beats or explain its value — required for an overview/landing page"
  suggested_fix: |
    Beats are lightweight data shippers that collect and forward operational data—such as logs, metrics, and network flows—to Elasticsearch or Logstash. ECK manages Beats as Kubernetes-native resources, handling TLS configuration and Elasticsearch authentication automatically. This section describes how to configure and deploy Beats with ECK.

- file: deploy-manage/deploy/cloud-on-k8s/configuration-beats.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "No opening paragraph; H1 is immediately followed by the first H2 section ('## Upgrade the Beat specification') with no introductory prose"
  suggested_fix: |
    Use this page to configure Beats resources managed by ECK. You can upgrade the Beat specification, define the Beat configuration inline or via a Secret, set the Elasticsearch output, manage secure settings through the Beats keystore, and set up Kibana dashboards.

- file: deploy-manage/deploy/cloud-on-k8s/configuration-logstash.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "No opening paragraph; H1 is immediately followed by the first H2 section ('## Upgrade the Logstash specification') with no introductory prose"
  suggested_fix: |
    Use this page to configure Logstash resources managed by ECK. You can define the Logstash configuration, set up pipelines, configure data volumes, connect Logstash to Elasticsearch using `elasticsearchRefs`, and expose Logstash services.

- file: deploy-manage/deploy/cloud-on-k8s/configuration-standalone.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "No opening paragraph; H1 is immediately followed by the first H2 section ('## Upgrade the Elastic Agent specification') with no introductory prose"
  suggested_fix: |
    Use this page to configure standalone Elastic Agent resources managed by ECK. You can upgrade the Agent specification, define the Agent configuration inline, set the Elasticsearch output, and manage certificate-based secure connections.

- file: deploy-manage/deploy/cloud-on-k8s/connect-to-apm-server.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "Opening paragraph is 'This section covers the following topics:' followed by a bullet list — no explanatory prose about what connecting to APM Server involves or why"
  suggested_fix: |
    After deploying an APM Server with ECK, you can access it through a Kubernetes service. ECK creates the service and manages authentication credentials automatically. This page explains how to retrieve the APM Server endpoint, obtain the secret token for agent authentication, and use API keys as an alternative authentication method.

- file: deploy-manage/deploy/cloud-on-k8s/http-configuration.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "No opening paragraph; H1 'Elastic Maps HTTP configuration' is immediately followed by the first H2 section with no introductory prose describing the page scope"
  suggested_fix: |
    By default, ECK creates a `ClusterIP` Kubernetes service for every Elastic Maps Server deployment. Use this page to configure the HTTP layer: expose the service with a load balancer, provide a custom TLS certificate, disable TLS, or configure Ingress.

- file: deploy-manage/deploy/cloud-on-k8s/logstash.md
  line: 13
  category: weak-opening
  severity: medium
  evidence: "Opening is a single sentence ('This section describes how to configure and deploy {{ls}} with ECK.') that does not define Logstash or explain its value — required for an overview/landing page"
  suggested_fix: |
    Logstash is a server-side data processing pipeline that ingests data from multiple sources, transforms it, and sends it to Elasticsearch or other destinations. ECK manages Logstash as a Kubernetes-native resource with automated TLS and Elasticsearch integration. This section describes how to configure and deploy Logstash with ECK.

- file: deploy-manage/deploy/cloud-on-k8s/volume-claim-templates.md
  line: 14
  category: weak-opening
  severity: medium
  evidence: "No opening paragraph; H1 is immediately followed by an H3 section (skipping H2), with no introductory prose explaining what volume claim templates are or why they matter for ECK deployments"
  suggested_fix: |
    Volume claim templates define the persistent storage provisioned for each Elasticsearch node in ECK-managed clusters. ECK uses PersistentVolumeClaims to ensure data durability across Pod restarts and rescheduling. For production workloads, configure the storage capacity and storage class to match your performance and resilience requirements.

Done when

  • All 4 listed pages have the [anchor-id] suffix restored on their H1.
  • All 9 listed configuration and overview pages have a 2–4 sentence opening paragraph that conveys purpose and scope before the first section heading.
  • A PR addressing this issue is merged.

Generated by Docs page-openings sweep agent · 916.6 AIC · ⌖ 25.1 AIC · ⊞ 27K ·

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs-fix:openingsPage openings: vague H1, weak intro, missing prerequisitesdocs-quality-sweepParent label for AI-generated docs-quality-sweep findings

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions