prometheus / prometheus/docs

Configuration documentation

Open
#1,951 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We need some documentation about Prometheus configuration.

Something like we have in the reference docs but with only the most useful fields, and with examples. It should be prometheus-version agnostic. Features introduced recently should be marked as such.

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

Start by reviewing the existing Prometheus reference documentation and identify the most useful configuration fields to cover. Done means a version-agnostic guide with examples, with recently introduced features clearly marked.

Written by the indexing model from the issue text.

Assessment

Tech stack
prometheus
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.