mirrors/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2025-08-07 14:47:11 +02:00
Code Issues Projects Releases Wiki Activity

Standardize doc page title handling

Browse Source 
See https://groups.google.com/g/prometheus-developers/c/cwL3cM66Em8

Signed-off-by: Julius Volz <julius.volz@gmail.com>
This commit is contained in:
Julius Volz 2025-05-28 21:37:27 +02:00
parent ab1b1db128
commit 13564c03ef
25 changed files with 39 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/command-line/prometheus.md
View File

@ -2,12 +2,9 @@
title: prometheus title: prometheus
--- ---
# prometheus
The Prometheus monitoring server The Prometheus monitoring server
## Flags ## Flags
| Flag | Description | Default | | Flag | Description | Default |

3
docs/command-line/promtool.md
View File

@ -2,12 +2,9 @@
title: promtool title: promtool
--- ---
# promtool
Tooling for the Prometheus monitoring system. Tooling for the Prometheus monitoring system.
## Flags ## Flags
| Flag | Description | | Flag | Description |

2
docs/configuration/alerting_rules.md
View File

@ -3,8 +3,6 @@ title: Alerting rules
sort_rank: 3 sort_rank: 3
--- ---
# Alerting rules
Alerting rules allow you to define alert conditions based on Prometheus Alerting rules allow you to define alert conditions based on Prometheus
expression language expressions and to send notifications about firing alerts expression language expressions and to send notifications about firing alerts
to an external service. Whenever the alert expression results in one or more to an external service. Whenever the alert expression results in one or more

2
docs/configuration/configuration.md
View File

@ -3,8 +3,6 @@ title: Configuration
sort_rank: 1 sort_rank: 1
--- ---
# Configuration
Prometheus is configured via command-line flags and a configuration file. While Prometheus is configured via command-line flags and a configuration file. While
the command-line flags configure immutable system parameters (such as storage the command-line flags configure immutable system parameters (such as storage
locations, amount of data to keep on disk and in memory, etc.), the locations, amount of data to keep on disk and in memory, etc.), the

2
docs/configuration/https.md
View File

@ -3,8 +3,6 @@ title: HTTPS and authentication
sort_rank: 7 sort_rank: 7
--- ---
# HTTPS and authentication
Prometheus supports basic authentication and TLS. Prometheus supports basic authentication and TLS.
This is **experimental** and might change in the future. This is **experimental** and might change in the future.

5
docs/configuration/recording_rules.md
View File

@ -1,10 +1,9 @@
--- ---
title: Recording rules title: Defining recording rules
nav_title: Recording rules
sort_rank: 2 sort_rank: 2
--- ---
# Defining recording rules
## Configuring rules ## Configuring rules
Prometheus supports two types of rules which may be configured and then Prometheus supports two types of rules which may be configured and then

2
docs/configuration/template_examples.md
View File

@ -3,8 +3,6 @@ title: Template examples
sort_rank: 4 sort_rank: 4
--- ---
# Template examples
Prometheus supports templating in the annotations and labels of alerts, Prometheus supports templating in the annotations and labels of alerts,
as well as in served console pages. Templates have the ability to run as well as in served console pages. Templates have the ability to run
queries against the local database, iterate over data, use conditionals, queries against the local database, iterate over data, use conditionals,

2
docs/configuration/template_reference.md
View File

@ -3,8 +3,6 @@ title: Template reference
sort_rank: 5 sort_rank: 5
--- ---
# Template reference
Prometheus supports templating in the annotations and labels of alerts, Prometheus supports templating in the annotations and labels of alerts,
as well as in served console pages. Templates have the ability to run as well as in served console pages. Templates have the ability to run
queries against the local database, iterate over data, use conditionals, queries against the local database, iterate over data, use conditionals,

4
docs/configuration/unit_testing_rules.md
View File

@ -1,10 +1,8 @@
--- ---
title: Unit Testing for Rules title: Unit testing for rules
sort_rank: 6 sort_rank: 6
--- ---
# Unit Testing for Rules
You can use `promtool` to test your rules. You can use `promtool` to test your rules.
```shell ```shell

2
docs/feature_flags.md
View File

@ -3,8 +3,6 @@ title: Feature flags
sort_rank: 12 sort_rank: 12
--- ---
# Feature flags
Here is a list of features that are disabled by default since they are breaking changes or are considered experimental. Here is a list of features that are disabled by default since they are breaking changes or are considered experimental.
Their behaviour can change in future releases which will be communicated via the [release changelog](https://github.com/prometheus/prometheus/blob/main/CHANGELOG.md). Their behaviour can change in future releases which will be communicated via the [release changelog](https://github.com/prometheus/prometheus/blob/main/CHANGELOG.md).

2
docs/federation.md
View File

@ -3,8 +3,6 @@ title: Federation
sort_rank: 6 sort_rank: 6
--- ---
# Federation
Federation allows a Prometheus server to scrape selected time series from Federation allows a Prometheus server to scrape selected time series from
another Prometheus server. another Prometheus server.

2
docs/getting_started.md
View File

@ -3,8 +3,6 @@ title: Getting started
sort_rank: 1 sort_rank: 1
--- ---
# Getting started
This guide is a "Hello World"-style tutorial which shows how to install, This guide is a "Hello World"-style tutorial which shows how to install,
configure, and use a simple Prometheus instance. You will download and run configure, and use a simple Prometheus instance. You will download and run
Prometheus locally, configure it to scrape itself and an example application, Prometheus locally, configure it to scrape itself and an example application,

5
docs/http_sd.md
View File

@ -1,10 +1,9 @@
--- ---
title: HTTP SD title: Writing HTTP service discovery
nav_title: HTTP SD
sort_rank: 7 sort_rank: 7
--- ---
# Writing HTTP Service Discovery
Prometheus provides a generic [HTTP Service Discovery](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config), Prometheus provides a generic [HTTP Service Discovery](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config),
that enables it to discover targets over an HTTP endpoint. that enables it to discover targets over an HTTP endpoint.

2
docs/installation.md
View File

@ -3,8 +3,6 @@ title: Installation
sort_rank: 2 sort_rank: 2
--- ---
# Installation
## Using pre-compiled binaries ## Using pre-compiled binaries
We provide precompiled binaries for most official Prometheus components. Check We provide precompiled binaries for most official Prometheus components. Check

10
docs/management_api.md
View File

@ -3,12 +3,10 @@ title: Management API
sort_rank: 8 sort_rank: 8
--- ---
# Management API
Prometheus provides a set of management APIs to facilitate automation and integration. Prometheus provides a set of management APIs to facilitate automation and integration.
### Health check ## Health check
``` ```
GET /-/healthy GET /-/healthy
@ -18,7 +16,7 @@ HEAD /-/healthy
This endpoint always returns 200 and should be used to check Prometheus health. This endpoint always returns 200 and should be used to check Prometheus health.
### Readiness check ## Readiness check
``` ```
GET /-/ready GET /-/ready
@ -28,7 +26,7 @@ HEAD /-/ready
This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries). This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries).
### Reload ## Reload
``` ```
PUT /-/reload PUT /-/reload
@ -40,7 +38,7 @@ This endpoint triggers a reload of the Prometheus configuration and rule files.
Alternatively, a configuration reload can be triggered by sending a `SIGHUP` to the Prometheus process. Alternatively, a configuration reload can be triggered by sending a `SIGHUP` to the Prometheus process.
### Quit ## Quit
``` ```
PUT /-/quit PUT /-/quit

5
docs/migration.md
View File

@ -1,10 +1,9 @@
--- ---
title: Migration title: Prometheus 3.0 migration guide
nav_title: Migration
sort_rank: 10 sort_rank: 10
--- ---
# Prometheus 3.0 migration guide
In line with our [stability promise](https://prometheus.io/docs/prometheus/latest/stability/), In line with our [stability promise](https://prometheus.io/docs/prometheus/latest/stability/),
the Prometheus 3.0 release contains a number of backwards incompatible changes. the Prometheus 3.0 release contains a number of backwards incompatible changes.
This document offers guidance on migrating from Prometheus 2.x to Prometheus 3.0 and newer versions. This document offers guidance on migrating from Prometheus 2.x to Prometheus 3.0 and newer versions.

2
docs/querying/api.md
View File

@ -3,8 +3,6 @@ title: HTTP API
sort_rank: 7 sort_rank: 7
--- ---
# HTTP API
The current stable HTTP API is reachable under `/api/v1` on a Prometheus The current stable HTTP API is reachable under `/api/v1` on a Prometheus
server. Any non-breaking additions will be added under that endpoint. server. Any non-breaking additions will be added under that endpoint.

2
docs/querying/basics.md
View File

@ -4,8 +4,6 @@ nav_title: Basics
sort_rank: 1 sort_rank: 1
--- ---
# Querying Prometheus
Prometheus provides a functional query language called PromQL (Prometheus Query Prometheus provides a functional query language called PromQL (Prometheus Query
Language) that lets the user select and aggregate time series data in real Language) that lets the user select and aggregate time series data in real
time. time.

4
docs/querying/examples.md
View File

@ -1,11 +1,9 @@
--- ---
title: Querying examples title: Query examples
nav_title: Examples nav_title: Examples
sort_rank: 4 sort_rank: 4
--- ---
# Query examples
## Simple time series selection ## Simple time series selection
Return all time series with the metric `http_requests_total`: Return all time series with the metric `http_requests_total`:

2
docs/querying/functions.md
View File

@ -4,8 +4,6 @@ nav_title: Functions
sort_rank: 3 sort_rank: 3
--- ---
# Functions
Some functions have default arguments, e.g. `year(v=vector(time()) Some functions have default arguments, e.g. `year(v=vector(time())
instant-vector)`. This means that there is one argument `v` which is an instant instant-vector)`. This means that there is one argument `v` which is an instant
vector, which if not provided it will default to the value of the expression vector, which if not provided it will default to the value of the expression

2
docs/querying/operators.md
View File

@ -3,8 +3,6 @@ title: Operators
sort_rank: 2 sort_rank: 2
--- ---
# Operators
## Binary operators ## Binary operators
Prometheus's query language supports basic logical and arithmetic operators. Prometheus's query language supports basic logical and arithmetic operators.

8
docs/querying/remote_read_api.md
View File

@ -3,9 +3,7 @@ title: Remote Read API
sort_rank: 7 sort_rank: 7
--- ---
# Remote Read API NOTE: This is not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.
> This is not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.
This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression. This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression.
The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto). The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto).
@ -15,12 +13,12 @@ Request are made to the following endpoint.
/api/v1/read /api/v1/read
``` ```
### Samples ## Samples
This returns a message that includes a list of raw samples matching the This returns a message that includes a list of raw samples matching the
requested query. requested query.
### Streamed Chunks ## Streamed Chunks
These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf) These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf)
compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second. compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second.

5
docs/stability.md
View File

@ -1,10 +1,9 @@
--- ---
title: API Stability title: API stability guarantees
nav_title: API stability
sort_rank: 11 sort_rank: 11
--- ---
# API Stability Guarantees
Prometheus promises API stability within a major version, and strives to avoid Prometheus promises API stability within a major version, and strives to avoid
breaking changes for key features. Some features, which are cosmetic, still breaking changes for key features. Some features, which are cosmetic, still
under development, or depend on 3rd party services, are not covered by this. under development, or depend on 3rd party services, are not covered by this.

2
docs/storage.md
View File

@ -3,8 +3,6 @@ title: Storage
sort_rank: 5 sort_rank: 5
--- ---
# Storage
Prometheus includes a local on-disk time series database, but also optionally integrates with remote storage systems. Prometheus includes a local on-disk time series database, but also optionally integrates with remote storage systems.
## Local storage ## Local storage

5
util/documentcli/documentcli.go
View File

@ -58,11 +58,8 @@ func header(title, help string) []byte {
title: %s title: %s
--- ---
# %s
%s %s
`, title, help))
`, title, title, help))
} }
func createFlagRow(flag *kingpin.FlagModel) []string { func createFlagRow(flag *kingpin.FlagModel) []string {