Skip to content

Docs: Broken yaml file + duplicate header #4982

@kakabisht

Description

@kakabisht

There are a couple of documentation issues on the Configuration and High Availability pages that may cause confusion for readers and lead to configuration errors.

  1. Invalid YAML formatting in subsection

Page:
https://prometheus.io/docs/alerting/latest/high_availability/

Description: One of the subsections includes a code block marked as yaml, but the content is not valid YAML. The snippet appears to describe configuration structure rather than a working configuration example.

Because the block is presented as YAML, readers may attempt to copy it directly into their configuration. This creates friction during setup and can result in configuration errors or failed validation.

Expected behavior: Remove YAML syntax highlighting if the content is intended as a configuration reference rather than executable YAML.

  1. Duplicate heading

Page: https://prometheus.io/docs/alerting/latest/high_availability/

The heading High Availability appears twice within the same page. This looks like an unintentional repetition of the title and may affect navigation and readability.

Expected behavior: The heading should appear only once, or the repeated section should be renamed if it represents a different subsection.

Additional notes

These issues were observed while following the documentation during setup and may affect first-time users relying on the examples for configuration.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    To triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions