Commit Graph

18 Commits

Author SHA1 Message Date
Julius Volz
13564c03ef Standardize doc page title handling
See https://groups.google.com/g/prometheus-developers/c/cwL3cM66Em8

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2025-05-28 21:37:27 +02:00
Julius Volz
1b818b03d5 Clean up codeboxes and headings in docs
The new docs site will have syntax highlighting, so this adds language tags
to code boxes that are currently missing them. I didn't add `promql` as a
language yet since the highlighter doesn't support it yet, plus a lot of
the PromQL codeboxes in our docs aren't strictly valid PromQL, they are
more like multiple expressions listed in the same code box on multiple
lines. So I'm leaving that for sometime later.

In the HTTP API page, I moved the curl examples from the JSON codeboxes to
their own ones above the JSON output. I considered putting an "Output:"
text between the curl + JSON output, but I think the way it currently looks
without it is probably fine.

I also fixed a number of headings which were at the wrong level relative to
their nesting in the document.

I also removed `go` as a language from the Go template language examples,
because the Go template language isn't Go at all.

I also adjusted the indent on one codebox to be more reasonable (2 spaces
instead of 8).

And then finally, my editor made a bunch of whitespace changes
automatically, like removing trailing spaces.

Signed-off-by: Julius Volz <julius.volz@gmail.com>

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2025-05-13 15:38:29 +02:00
machine424
5d248e2d10
docs: improve section about Prometheus graceful shutdown.
fixes https://github.com/prometheus/prometheus/issues/13183

Signed-off-by: machine424 <ayoubmrini424@gmail.com>
2024-12-03 19:48:42 +01:00
Akshay Siwal
4c898fc4a1
Update getting_started.md
Updating signal for graceful shutdown.

Signed-off-by: Akshay Siwal <akshay.singh.siwal@gmail.com>
2023-05-15 13:18:30 +05:30
Harold Dost
3125e169ae docs: Add signal information to getting started
Closes prometheus/docs#167

Signed-off-by: Harold Dost <h.dost@criteo.com>
2023-03-12 00:31:04 +01:00
Juozas Vainauskas
ad6ae2cccc Update getting started guide with the new UI
Signed-off-by: Juozas Vainauskas <vainauskasjuozas@gmail.com>
2022-01-14 23:14:55 +02:00
Anthony D'Atri
2cbc0f9bfe
Various doc tweaks (#8111)
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-27 09:50:37 +00:00
Harold Dost
0e2004f6fb
Simplify the Getting Started documentation. (#7193)
- Reduce the level of entry to start gathering metrics with prometheus
  by suggesting to just download pre-built exporters instead of requiring
  the reader to download an entire Golang build chain and checkout a project.

Fix #6956

Signed-off-by: Harold Dost <h.dost@criteo.com>
2020-05-04 11:49:45 +01:00
Diana Payton
6ab413ab41
Docs: Update getting_started.md (#6955)
* Update getting_started.md

Signed-off-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-03-10 20:02:41 +00:00
Eyal Levin
d304269ac4 Update text (#5039)
The `rule_files` section is not inside the `global` configuration section

Signed-off-by: Eyal Levin <eyalev@gmail.com>
2018-12-25 13:28:56 +00:00
Goutham Veeramachaneni
646e33242e docs: Fix minor issues with the docs. (#3389)
Signed-off-by: Goutham Veeramachaneni <cs14btech11014@iith.ac.in>
2017-11-01 15:35:50 +00:00
Brian Brazil
efaa8f9ce8 Update getting started with new rules format 2017-10-31 13:58:09 +00:00
Fabian Reinartz
8cc78b36a2 docs: remove obsolete info in getting started
Go automatically configures the number of used threads appropriately
and tweaking it is no longer relevant for a basic setup of Prometheus.
The baseline consumption tied to the storage layer no longer applies.
2017-10-28 12:09:03 +02:00
Fabian Reinartz
8a2b5a3936 docs: update flags to new double-dash syntax 2017-10-28 12:08:33 +02:00
Tobias Schmidt
f432b8176d Consolidate configuration and rules docs in docs/configuration/ 2017-10-27 09:54:02 +02:00
Tobias Schmidt
e6cdc2d355 Import querying documentation from prometheus/docs 2017-10-26 22:36:47 +02:00
Tobias Schmidt
299802dfd0 Integrate changes from prometheus/docs 2017-10-26 16:14:43 +02:00
Tobias Schmidt
53a5f52224 Import first batch of Prometheus documentation
In order to provide documentation for each individual version, this
commit starts moving Prometheus server specific documentation into the
repository itself.
2017-10-26 16:14:43 +02:00