From aad7bb9123fec5b0a4368f30aeb31b7148cfdd79 Mon Sep 17 00:00:00 2001 From: Julien Pivotto Date: Sat, 29 May 2021 00:48:50 +0200 Subject: [PATCH 1/2] Add a design docs page Signed-off-by: Julien Pivotto --- content/docs/introduction/design-doc.md | 44 +++++++++++++++++++++++++ content/docs/introduction/glossary.md | 2 +- content/docs/introduction/media.md | 2 +- 3 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 content/docs/introduction/design-doc.md diff --git a/content/docs/introduction/design-doc.md b/content/docs/introduction/design-doc.md new file mode 100644 index 000000000..133e07907 --- /dev/null +++ b/content/docs/introduction/design-doc.md @@ -0,0 +1,44 @@ +--- +title: Design Documents +sort_rank: 7 +--- + +# Design documents + +When contributing large changes or features to the Prometheus ecosystem, design +documents are written by individuals or groups. Those documents are proposed for +review and approval to the community. + +This page is a list of the design documents we know of. If you create a new +design document, or some documents are not listed, please open a [pull +request](https://github.com/prometheus/docs/) to add it to this list. + +Design doc do not always reflect exactly what has been implemented, and +implementation details might have changed since a feature was merged. Design +docs are not considered documentation. + +If you want to pick a design doc in `TODO` or implement a proposed design doc, +please reach out to the [developers mailing list](/community) first to make sure +no one else has picked that task already, and the design doc is approved and +still relevant. + +| Document | Initial date | Status | Pull requests | +| -------- | ------------ | ------ | ------------- | +| | +| [Secure Alertmanager cluster traffic](https://github.com/prometheus/alertmanager/blob/master/doc/design/secure-cluster-traffic.md) | 2019-02-21 | Approved | [alertmanager#2237](https://github.com/prometheus/alertmanager/pull/2237) | +| TSDB Head Improvements ([part1](https://docs.google.com/document/d/184urkLQnM7rqLmGvS66I15jU2pyPk_qwd8v_qDlXczo/edit#heading=h.ow34omg0frla) - [part 2](https://docs.google.com/document/d/1pnEsxB0CDLOxQipGw_vhkJpoDZfZPs_KjqCriumDAXQ/edit#heading=h.qsf5sgqoqemc)) | 2019-12-09 | Partially implemented | | +| [Persist Retroactive Rules](https://docs.google.com/document/d/16s_-RxYwQYcb4G4mvpmjPolEbD24o54a1LPqJ538Vhc/edit) | 2020-06-12 | Partially implemented | [#7675](https://github.com/prometheus/prometheus/pull/7675) | +| [topk/bottomk aggregation over time](https://docs.google.com/document/d/1uSbD3T2beM-iX4-Hp7V074bzBRiRNlqUdcWP6JTDQSs/edit) | 2020-09-30 | Implemented | [#8121](https://github.com/prometheus/prometheus/pull/8121) [#8425](https://github.com/prometheus/prometheus/pull/8425) | +| [http\_sd\_configs](https://docs.google.com/document/d/1tVeuzjpU4-TiYPNWJXKmcyIuZF6A2tUq270RbBT5zho/edit) | 2021-02-26 | Under review | [#8839](https://github.com/prometheus/prometheus/pull/8839) | +| [prometheus/client\_java & micrometer](https://docs.google.com/document/d/1vROky2aIw3kAllfi95gwDJy5P2DyWnCihsjPXGpLwwo/edit#) | 2021-02-26 | Under review | | +| [First-class network monitoring support in the Prometheus & Grafana ecosystem](https://docs.google.com/document/d/1oEpjiWfTHF352NCAOGolwij3EIkrprCkdQmaQMpjg4M/edit) | 2021-02-25 | Under review | | +| [Configuration handling in exporters and Prometheus 3.x](https://docs.google.com/document/d/1BK_Gc3ixoWyxr9F5qGC07HEcfDPtb6z96mfqoGyz52Y/edit#heading=h.zcana55kzmxi) | 2021-03-29 | Under review | | +| [Prometheus Agent](https://docs.google.com/document/d/1cCcoFgjDFwU2n823tKuMvrIhzHty4UDyn0IcfUHiyyI/edit) | 2021-01-27 | Approved | [#8785](https://github.com/prometheus/prometheus/pull/8785) | +| [Sparse high-resolution histograms](https://docs.google.com/document/d/1cLNv3aufPZb3fNfaJgdaRBZsInZKKIHo9E6HinJVbpM/edit) | 2021-02-10 | Approved | | +| [Prometheus timezones support](https://docs.google.com/document/d/1xfw1Lb1GIRZB_-4iFVGkgwnpwuBemWfxYqFdBm7APsE/edit#) | 2021-05-29 | Proposed | | +| [Moving to goreleaser](https://docs.google.com/document/d/16LOT2wK-jntlU-EFADfaEF3YbKH81U9Zl_PvSu4qVwo/edit#heading=h.bupciudrwmna) | 2021-06-05 | Proposed | +| [Alertmanager Log Receiver](https://docs.google.com/document/d/1Oevu2stHVGAupzmc9C7_wW5nTb_CJ6Ut72viXfve6zI/edit?usp=sharing) | 2021-06-10 | Proposed | +| [Metadata](https://docs.google.com/document/d/1XiZePSjwU4X5iaIgCIvLzljJzl8lRAdvputuborUcaQ/edit) | | TODO | | +| OpenMetrics transition | | TODO | | +| Semantics of muting in Alertmanager | | TODO | | +| Extrapolation in range selectors (xrange) | | TODO | | diff --git a/content/docs/introduction/glossary.md b/content/docs/introduction/glossary.md index 1b8535dc2..239d46172 100644 --- a/content/docs/introduction/glossary.md +++ b/content/docs/introduction/glossary.md @@ -1,6 +1,6 @@ --- title: Glossary -sort_rank: 8 +sort_rank: 9 --- # Glossary diff --git a/content/docs/introduction/media.md b/content/docs/introduction/media.md index b6b994e62..e84e5f5e4 100644 --- a/content/docs/introduction/media.md +++ b/content/docs/introduction/media.md @@ -1,6 +1,6 @@ --- title: Media -sort_rank: 7 +sort_rank: 8 --- # Media From e3daafac553428145cb6e7d95365dd0eff2d1a96 Mon Sep 17 00:00:00 2001 From: Julien Pivotto Date: Wed, 16 Jun 2021 14:26:15 +0200 Subject: [PATCH 2/2] Fix last comments Signed-off-by: Julien Pivotto --- content/docs/introduction/design-doc.md | 31 ++++++++++++------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/content/docs/introduction/design-doc.md b/content/docs/introduction/design-doc.md index 133e07907..fdab1e37d 100644 --- a/content/docs/introduction/design-doc.md +++ b/content/docs/introduction/design-doc.md @@ -13,9 +13,9 @@ This page is a list of the design documents we know of. If you create a new design document, or some documents are not listed, please open a [pull request](https://github.com/prometheus/docs/) to add it to this list. -Design doc do not always reflect exactly what has been implemented, and +Design docs do not always reflect exactly what has been implemented, and implementation details might have changed since a feature was merged. Design -docs are not considered documentation. +docs are not considered documentation and can not define a standard. If you want to pick a design doc in `TODO` or implement a proposed design doc, please reach out to the [developers mailing list](/community) first to make sure @@ -24,20 +24,19 @@ still relevant. | Document | Initial date | Status | Pull requests | | -------- | ------------ | ------ | ------------- | -| | -| [Secure Alertmanager cluster traffic](https://github.com/prometheus/alertmanager/blob/master/doc/design/secure-cluster-traffic.md) | 2019-02-21 | Approved | [alertmanager#2237](https://github.com/prometheus/alertmanager/pull/2237) | -| TSDB Head Improvements ([part1](https://docs.google.com/document/d/184urkLQnM7rqLmGvS66I15jU2pyPk_qwd8v_qDlXczo/edit#heading=h.ow34omg0frla) - [part 2](https://docs.google.com/document/d/1pnEsxB0CDLOxQipGw_vhkJpoDZfZPs_KjqCriumDAXQ/edit#heading=h.qsf5sgqoqemc)) | 2019-12-09 | Partially implemented | | -| [Persist Retroactive Rules](https://docs.google.com/document/d/16s_-RxYwQYcb4G4mvpmjPolEbD24o54a1LPqJ538Vhc/edit) | 2020-06-12 | Partially implemented | [#7675](https://github.com/prometheus/prometheus/pull/7675) | -| [topk/bottomk aggregation over time](https://docs.google.com/document/d/1uSbD3T2beM-iX4-Hp7V074bzBRiRNlqUdcWP6JTDQSs/edit) | 2020-09-30 | Implemented | [#8121](https://github.com/prometheus/prometheus/pull/8121) [#8425](https://github.com/prometheus/prometheus/pull/8425) | -| [http\_sd\_configs](https://docs.google.com/document/d/1tVeuzjpU4-TiYPNWJXKmcyIuZF6A2tUq270RbBT5zho/edit) | 2021-02-26 | Under review | [#8839](https://github.com/prometheus/prometheus/pull/8839) | -| [prometheus/client\_java & micrometer](https://docs.google.com/document/d/1vROky2aIw3kAllfi95gwDJy5P2DyWnCihsjPXGpLwwo/edit#) | 2021-02-26 | Under review | | -| [First-class network monitoring support in the Prometheus & Grafana ecosystem](https://docs.google.com/document/d/1oEpjiWfTHF352NCAOGolwij3EIkrprCkdQmaQMpjg4M/edit) | 2021-02-25 | Under review | | -| [Configuration handling in exporters and Prometheus 3.x](https://docs.google.com/document/d/1BK_Gc3ixoWyxr9F5qGC07HEcfDPtb6z96mfqoGyz52Y/edit#heading=h.zcana55kzmxi) | 2021-03-29 | Under review | | -| [Prometheus Agent](https://docs.google.com/document/d/1cCcoFgjDFwU2n823tKuMvrIhzHty4UDyn0IcfUHiyyI/edit) | 2021-01-27 | Approved | [#8785](https://github.com/prometheus/prometheus/pull/8785) | -| [Sparse high-resolution histograms](https://docs.google.com/document/d/1cLNv3aufPZb3fNfaJgdaRBZsInZKKIHo9E6HinJVbpM/edit) | 2021-02-10 | Approved | | -| [Prometheus timezones support](https://docs.google.com/document/d/1xfw1Lb1GIRZB_-4iFVGkgwnpwuBemWfxYqFdBm7APsE/edit#) | 2021-05-29 | Proposed | | -| [Moving to goreleaser](https://docs.google.com/document/d/16LOT2wK-jntlU-EFADfaEF3YbKH81U9Zl_PvSu4qVwo/edit#heading=h.bupciudrwmna) | 2021-06-05 | Proposed | -| [Alertmanager Log Receiver](https://docs.google.com/document/d/1Oevu2stHVGAupzmc9C7_wW5nTb_CJ6Ut72viXfve6zI/edit?usp=sharing) | 2021-06-10 | Proposed | +| [Secure Alertmanager cluster traffic](https://github.com/prometheus/alertmanager/blob/master/doc/design/secure-cluster-traffic.md) | 2019‑02‑21 | Approved | [alertmanager#2237](https://github.com/prometheus/alertmanager/pull/2237) | +| TSDB Head Improvements ([part1](https://docs.google.com/document/d/184urkLQnM7rqLmGvS66I15jU2pyPk_qwd8v_qDlXczo/edit#heading=h.ow34omg0frla) - [part 2](https://docs.google.com/document/d/1pnEsxB0CDLOxQipGw_vhkJpoDZfZPs_KjqCriumDAXQ/edit#heading=h.qsf5sgqoqemc)) | 2019‑12‑09 | Partially implemented | | +| [Persist Retroactive Rules](https://docs.google.com/document/d/16s_-RxYwQYcb4G4mvpmjPolEbD24o54a1LPqJ538Vhc/edit) | 2020‑06‑12 | Partially implemented | [#7675](https://github.com/prometheus/prometheus/pull/7675) | +| [topk/bottomk aggregation over time](https://docs.google.com/document/d/1uSbD3T2beM-iX4-Hp7V074bzBRiRNlqUdcWP6JTDQSs/edit) | 2020‑09‑30 | Implemented | [#8121](https://github.com/prometheus/prometheus/pull/8121) [#8425](https://github.com/prometheus/prometheus/pull/8425) | +| [http\_sd\_configs](https://docs.google.com/document/d/1tVeuzjpU4-TiYPNWJXKmcyIuZF6A2tUq270RbBT5zho/edit) | 2021‑02‑26 | Under review | [#8839](https://github.com/prometheus/prometheus/pull/8839) | +| [prometheus/client\_java & micrometer](https://docs.google.com/document/d/1vROky2aIw3kAllfi95gwDJy5P2DyWnCihsjPXGpLwwo/edit#) | 2021‑02‑26 | Under review | | +| [First-class network monitoring support in the Prometheus & Grafana ecosystem](https://docs.google.com/document/d/1oEpjiWfTHF352NCAOGolwij3EIkrprCkdQmaQMpjg4M/edit) | 2021‑02‑25 | Under review | | +| [Configuration handling in exporters and Prometheus 3.x](https://docs.google.com/document/d/1BK_Gc3ixoWyxr9F5qGC07HEcfDPtb6z96mfqoGyz52Y/edit#heading=h.zcana55kzmxi) | 2021‑03‑29 | Under review | | +| [Prometheus Agent](https://docs.google.com/document/d/1cCcoFgjDFwU2n823tKuMvrIhzHty4UDyn0IcfUHiyyI/edit) | 2021‑01‑27 | Approved | [#8785](https://github.com/prometheus/prometheus/pull/8785) | +| [Sparse high-resolution histograms](https://docs.google.com/document/d/1cLNv3aufPZb3fNfaJgdaRBZsInZKKIHo9E6HinJVbpM/edit) | 2021‑02‑10 | Approved | | +| [Prometheus timezones support](https://docs.google.com/document/d/1xfw1Lb1GIRZB_-4iFVGkgwnpwuBemWfxYqFdBm7APsE/edit#) | 2021‑05‑29 | Proposed | | +| [Moving to goreleaser](https://docs.google.com/document/d/16LOT2wK-jntlU-EFADfaEF3YbKH81U9Zl_PvSu4qVwo/edit#heading=h.bupciudrwmna) | 2021‑06‑05 | Proposed | +| [Alertmanager Log Receiver](https://docs.google.com/document/d/1Oevu2stHVGAupzmc9C7_wW5nTb_CJ6Ut72viXfve6zI/edit?usp=sharing) | 2021‑06‑10 | Proposed | | [Metadata](https://docs.google.com/document/d/1XiZePSjwU4X5iaIgCIvLzljJzl8lRAdvputuborUcaQ/edit) | | TODO | | | OpenMetrics transition | | TODO | | | Semantics of muting in Alertmanager | | TODO | |