Commit Graph

31 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
Aman
2be67be042
docs: remote-write-receiver explicit flag enablement (#16214)
* docs: remote-write-receiver explicit flag enablement

Signed-off-by: amanycodes <amanycodes@gmail.com>

* Rebuild

Signed-off-by: amanycodes <amanycodes@gmail.com>

* updated docs/migration.md

Signed-off-by: amanycodes <amanycodes@gmail.com>

---------

Signed-off-by: amanycodes <amanycodes@gmail.com>
2025-03-28 19:15:59 +01:00
co63oc
0e4e5a71bd
Fix typos (#16076)
Signed-off-by: co63oc <co63oc@users.noreply.github.com>
2025-02-28 11:24:25 +11:00
Owen Williams
f405c78e4a
docs: clarify PromQL interval changes (#15824)
docs: Clarify PromQL interval changes

---------

Signed-off-by: Owen Williams <owen.williams@grafana.com>
Signed-off-by: Owen Williams <owen-github@ywwg.com>
Co-authored-by: Björn Rabenstein <beorn@grafana.com>
2025-01-17 18:00:30 +01:00
Chris Gray
c8f0e9d9c9
Fix typo
Signed-off-by: Chris Gray <chris.gray@aem.eco>
2024-11-26 09:05:39 -08:00
Jan Fajerski
84396bf636 migration: add removal of AM v1 api
Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
2024-11-13 15:40:58 +01:00
Fiona Liao
928e691bc6
Merge branch 'release-3.0' into fix-migration-guide
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-12 09:43:42 +00:00
Jan Fajerski
3067d0bc2f update CHANGELOG and migration guide
Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
2024-11-11 22:32:26 +00:00
Bartlomiej Plotka
99cbdc113c
Update migration.md for TSDB storage upgrade
Signed-off-by: Bartlomiej Plotka <bwplotka@gmail.com>
2024-11-11 19:32:48 +00:00
Fiona Liao
67764d7cfd Better spacing for flags
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-11 18:31:50 +00:00
Fiona Liao
b2fd5b7e45 Format PromQL section, replace table
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-11 18:31:43 +00:00
Fiona Liao
962a3cd6be Add backticks to fallback_scrape_protocol
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-11 18:31:34 +00:00
Fiona Liao
ad8138a65d Add newlines before code blocks
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-11 18:31:28 +00:00
Fiona Liao
54a3f5054c docs: formatting and typo fixes to 3.0 migration guide
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-06 19:35:42 +00:00
Jan Fajerski
f131cdd4c5
3.0 migration guide (#15099)
* docs: 2 to 3 migration guide

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* docs/stability: add 3.0 section

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* docs/migration: details on enabling legacy name validation

Signed-off-by: Owen Williams <owen.williams@grafana.com>\

* migration: add log format and `le` normalization

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

* migration: add new enable_http2 default for remote write

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>

---------

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
Signed-off-by: Owen Williams <owen.williams@grafana.com>
Co-authored-by: Owen Williams <owen.williams@grafana.com>
2024-10-25 12:30:13 +02:00
Julien Pivotto
1922db0586 Document command line tools
Signed-off-by: Julien Pivotto <roidelapluie@o11y.eu>
2023-03-13 14:20:55 +01:00
Julius Volz
4a5aef0495
Merge release-2.28 back into main (#8975)
* Cut v2.28.0-rc.0 (#8954)

* Cut v2.28.0-rc.0

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

* Changelog fixup

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

* Address review comments

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

* Downgrade some features to enhancements

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

* Adjust release date to today

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

* Migrate HTTP SD docs from docs repo (#8972)

See discussion in https://github.com/prometheus/docs/pull/1975

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

* Cut Prometheus v2.28.0 (#8973)

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2021-06-22 00:59:31 +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
Christian Hoffmann
51306cb158
docs: add promtool version in rule migration cmd (#6989)
`promtool update rules` is no longer available after Prometheus 2.5.
Document this to avoid confusion such as in #6988.

Signed-off-by: Christian Hoffmann <mail@hoffmann-christian.info>
2020-09-07 16:30:07 +02:00
showuon
5dcc21887b
update the migrating doc for less confusion (#7845)
Signed-off-by: Luke Chen <showuon@gmail.com>
2020-08-25 10:04:05 +01:00
arthursens
0cbee82a58 Update docker example in migration guide
Signed-off-by: arthursens <arthursens2005@gmail.com>
2020-05-11 19:54:02 -03:00
Harold Dost
18d45e564b
Documentation: Update example expressions to follow convention. (#7195)
Based out of conversation on #7193

Signed-off-by: Harold Dost <h.dost@criteo.com>
2020-05-02 12:52:24 +01:00
Alan
42d10aea80 docs: fix error link in /migration.md (#6010)
docs: fix error link in /migration.md 
Signed-off-by: alan <zg.zhu@daocloud.io>
2019-09-11 11:01:41 +01:00
Marco Pracucci
2ccc48adc6 Documented /healthy, /ready and lifecycle API (#5737)
Signed-off-by: Marco Pracucci <marco.pracucci@spreaker.com>
2019-07-05 10:50:48 +01:00
Mike Rostermund
4648f4c156 New server uses read protocol, to eh, read. (#3444) 2017-12-14 12:20:28 +00:00
Tom Wilkie
d2f6803d14 'Prometheus lifecycle' should be a subsection of 'Miscellaneous' 2017-12-14 12:20:28 +00:00
Tobias Schmidt
87f5fe3576 Fix migration documentation title in docs menu 2017-12-14 12:20:28 +00:00
Brian Brazil
5dff97639f Tweak migration doc (#3430) 2017-12-14 12:20:28 +00:00
Jose Donizetti
b3b6538348 Small changes to migration guide 2017-12-14 12:20:28 +00:00
Tom Wilkie
617e7d0203 Add migration docs for 2.0 (#3374)
* Initial draft of migration.md

* Edits.

* Review feedback.

* Review feedback.

* Staleness link to video; add docker root example; remote config file section.

* s/NB/NOTE/, remove external labels link.

* More typos.

* Add more details link for removed PromQL features.

* s/you/your/

* Expand on prom1.8/2.0 side by side setup.

* More feedback.

* update links.

* --query.lookback-delta flag.
2017-11-08 08:14:33 +01:00