prometheus / prometheus/docs

doc error of alert manager configuration example (for the route,mute parts)

Open Beginner friendly
#2,171 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
717
Forks
1.2k
Avg merge
3d 15h
Merged PRs (30d)
19

Description

https://prometheus.io/docs/alerting/latest/configuration/#route

# Times when the route should be muted. These must match the name of a
# mute time interval defined in the mute_time_intervals section.
# Additionally, the root node cannot have any mute times.
# When a route is muted it will not send any notifications, but
# otherwise acts normally (including ending the route-matching process
# if the `continue` option is not set.)
mute_time_intervals:
  [ - [<string>](https://prometheus.io/docs/alerting/latest/configuration/#string) ...]

The "These must match the name of a mute time interval defined in the mute_time_intervals section". It should be
time_intervals section

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Alertmanager configuration documentation and inspect the route example, especially the mute_time_intervals description. Correct the reference to the appropriate time intervals section, then review the rendered section to confirm the wording is accurate and the example remains consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.