mirror of
https://github.com/coreos/prometheus-operator.git
synced 2026-02-05 06:45:27 +01:00
chore: Docs Restructuring (#6650)
This commit is contained in:
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
weight: 120
|
weight: 501
|
||||||
toc: true
|
toc: true
|
||||||
title: Contributing
|
title: Contributing
|
||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: prologue
|
parent: community
|
||||||
lead: ""
|
lead: ""
|
||||||
lastmod: "2021-03-08T08:48:57+00:00"
|
lastmod: "2021-03-08T08:48:57+00:00"
|
||||||
images: []
|
images: []
|
||||||
|
|||||||
12
DCO
12
DCO
@@ -1,3 +1,15 @@
|
|||||||
|
---
|
||||||
|
weight: 503
|
||||||
|
toc: true
|
||||||
|
title: DCO
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: community
|
||||||
|
lead: ""
|
||||||
|
images: []
|
||||||
|
draft: false
|
||||||
|
---
|
||||||
|
|
||||||
Developer Certificate of Origin
|
Developer Certificate of Origin
|
||||||
Version 1.1
|
Version 1.1
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
weight: 202
|
weight: 103
|
||||||
toc: true
|
toc: true
|
||||||
title: Compatibility
|
title: Compatibility
|
||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: operator
|
parent: prologue
|
||||||
lead: The Prometheus Operator supports a number of Kubernetes and Prometheus releases.
|
lead: The Prometheus Operator supports a number of Kubernetes and Prometheus releases.
|
||||||
images: []
|
images: []
|
||||||
draft: false
|
draft: false
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
weight: 201
|
weight: 104
|
||||||
toc: true
|
toc: true
|
||||||
title: Design
|
title: Design
|
||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: operator
|
parent: prologue
|
||||||
images: []
|
images: []
|
||||||
draft: false
|
draft: false
|
||||||
description: This document describes the design and interaction between the custom resource definitions that the Prometheus Operator manages.
|
description: This document describes the design and interaction between the custom resource definitions that the Prometheus Operator manages.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 203
|
weight: 256
|
||||||
toc: true
|
toc: true
|
||||||
title: High Availability
|
title: High Availability
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 212
|
weight: 259
|
||||||
toc: false
|
toc: false
|
||||||
title: CLI reference
|
title: CLI reference
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 205
|
weight: 255
|
||||||
toc: true
|
toc: true
|
||||||
title: RBAC for CRDs
|
title: RBAC for CRDs
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 204
|
weight: 254
|
||||||
toc: true
|
toc: true
|
||||||
title: RBAC
|
title: RBAC
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 208
|
weight: 253
|
||||||
toc: true
|
toc: true
|
||||||
title: Thanos
|
title: Thanos
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 209
|
weight: 260
|
||||||
toc: true
|
toc: true
|
||||||
title: Troubleshooting
|
title: Troubleshooting
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 152
|
weight: 202
|
||||||
toc: true
|
toc: true
|
||||||
title: Alerting
|
title: Alerting
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 151
|
weight: 201
|
||||||
toc: true
|
toc: true
|
||||||
title: Getting Started
|
title: Getting Started
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 153
|
weight: 252
|
||||||
toc: true
|
toc: true
|
||||||
title: Prometheus Agent
|
title: Prometheus Agent
|
||||||
menu:
|
menu:
|
||||||
@@ -187,4 +187,4 @@ spec:
|
|||||||
team: frontend
|
team: frontend
|
||||||
```
|
```
|
||||||
|
|
||||||
Continue with the [Getting Started page]({{<ref "getting-started">}}) to learn how to monitor applications running on Kubernetes.
|
Continue with the [Getting Started page]({{<ref "docs/developer/getting-started.md">}}) to learn how to monitor applications running on Kubernetes.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 154
|
weight: 203
|
||||||
toc: true
|
toc: true
|
||||||
title: ScrapeConfig CRD
|
title: ScrapeConfig CRD
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 206
|
weight: 257
|
||||||
toc: true
|
toc: true
|
||||||
title: Storage
|
title: Storage
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 207
|
weight: 258
|
||||||
toc: true
|
toc: true
|
||||||
title: Strategic Merge Patch
|
title: Strategic Merge Patch
|
||||||
menu:
|
menu:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
weight: 155
|
weight: 251
|
||||||
toc: true
|
toc: true
|
||||||
title: Admission webhook
|
title: Admission webhook
|
||||||
menu:
|
menu:
|
||||||
@@ -21,7 +21,7 @@ The admission webhook service is able to
|
|||||||
* Convert `AlertmanagerConfig` objects between `v1alpha1` and `v1beta1` versions.
|
* Convert `AlertmanagerConfig` objects between `v1alpha1` and `v1beta1` versions.
|
||||||
|
|
||||||
This guide assumes that you have already [deployed the Prometheus
|
This guide assumes that you have already [deployed the Prometheus
|
||||||
Operator]({{< ref "getting-started" >}}) and that [admission controllers are
|
Operator]({{< ref "docs/developer/getting-started.md" >}}) and that [admission controllers are
|
||||||
enabled](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#how-do-i-turn-on-an-admission-controller)
|
enabled](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#how-do-i-turn-on-an-admission-controller)
|
||||||
on your cluster.
|
on your cluster.
|
||||||
|
|
||||||
|
|||||||
3
LICENSE
3
LICENSE
@@ -176,7 +176,7 @@ Apache License
|
|||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
To apply the Apache License to your work, attach the following
|
||||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||||
replaced with your own identifying information. (Don't include
|
replaced with your own identifying information. (Don't include
|
||||||
@@ -199,4 +199,3 @@ Apache License
|
|||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
See the License for the specific language governing permissions and
|
See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
|
|
||||||
|
|||||||
12
RELEASE.md
12
RELEASE.md
@@ -1,3 +1,15 @@
|
|||||||
|
---
|
||||||
|
weight: 506
|
||||||
|
toc: true
|
||||||
|
title: Release
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: community
|
||||||
|
lead: ""
|
||||||
|
images: []
|
||||||
|
draft: false
|
||||||
|
---
|
||||||
|
|
||||||
# Release schedule
|
# Release schedule
|
||||||
|
|
||||||
Following [Prometheus](https://github.com/prometheus/prometheus/blob/main/RELEASE.md) and [Thanos](https://github.com/thanos-io/thanos/blob/main/docs/release-process.md), this project aims for a predictable release schedule.
|
Following [Prometheus](https://github.com/prometheus/prometheus/blob/main/RELEASE.md) and [Thanos](https://github.com/thanos-io/thanos/blob/main/docs/release-process.md), this project aims for a predictable release schedule.
|
||||||
|
|||||||
12
TESTING.md
12
TESTING.md
@@ -1,3 +1,15 @@
|
|||||||
|
---
|
||||||
|
weight: 502
|
||||||
|
toc: true
|
||||||
|
title: Testing
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: community
|
||||||
|
lead: ""
|
||||||
|
images: []
|
||||||
|
draft: false
|
||||||
|
---
|
||||||
|
|
||||||
When contributing code to Prometheus-Operator, you'll notice that every Pull Request will run against an extensive test suite. Among an extensive list of benefits that tests brings to the Project's overall health and reliability, it can be the reviewer's and contributors's best friend during development:
|
When contributing code to Prometheus-Operator, you'll notice that every Pull Request will run against an extensive test suite. Among an extensive list of benefits that tests brings to the Project's overall health and reliability, it can be the reviewer's and contributors's best friend during development:
|
||||||
|
|
||||||
* Test cases serve as documentation, providing insights into the expected behavior of the software.
|
* Test cases serve as documentation, providing insights into the expected behavior of the software.
|
||||||
|
|||||||
@@ -1,3 +1,15 @@
|
|||||||
|
---
|
||||||
|
weight: 505
|
||||||
|
toc: true
|
||||||
|
title: Code of Conduct
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: community
|
||||||
|
lead: ""
|
||||||
|
images: []
|
||||||
|
draft: false
|
||||||
|
---
|
||||||
|
|
||||||
## Community Code of Conduct
|
## Community Code of Conduct
|
||||||
|
|
||||||
### Contributor Code of Conduct
|
### Contributor Code of Conduct
|
||||||
|
|||||||
Reference in New Issue
Block a user