1
0
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:
Ashwin Sriram
2024-07-02 17:38:03 +05:30
committed by GitHub
parent 22a0a9b49b
commit 91822d37d8
21 changed files with 70 additions and 23 deletions

View File

@@ -1,10 +1,10 @@
---
weight: 120
weight: 501
toc: true
title: Contributing
menu:
docs:
parent: prologue
parent: community
lead: ""
lastmod: "2021-03-08T08:48:57+00:00"
images: []

12
DCO
View File

@@ -1,3 +1,15 @@
---
weight: 503
toc: true
title: DCO
menu:
docs:
parent: community
lead: ""
images: []
draft: false
---
Developer Certificate of Origin
Version 1.1

View File

@@ -1,10 +1,10 @@
---
weight: 202
weight: 103
toc: true
title: Compatibility
menu:
docs:
parent: operator
parent: prologue
lead: The Prometheus Operator supports a number of Kubernetes and Prometheus releases.
images: []
draft: false

View File

@@ -1,10 +1,10 @@
---
weight: 201
weight: 104
toc: true
title: Design
menu:
docs:
parent: operator
parent: prologue
images: []
draft: false
description: This document describes the design and interaction between the custom resource definitions that the Prometheus Operator manages.

View File

@@ -1,5 +1,5 @@
---
weight: 203
weight: 256
toc: true
title: High Availability
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 212
weight: 259
toc: false
title: CLI reference
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 205
weight: 255
toc: true
title: RBAC for CRDs
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 204
weight: 254
toc: true
title: RBAC
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 208
weight: 253
toc: true
title: Thanos
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 209
weight: 260
toc: true
title: Troubleshooting
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 152
weight: 202
toc: true
title: Alerting
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 151
weight: 201
toc: true
title: Getting Started
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 153
weight: 252
toc: true
title: Prometheus Agent
menu:
@@ -187,4 +187,4 @@ spec:
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.

View File

@@ -1,5 +1,5 @@
---
weight: 154
weight: 203
toc: true
title: ScrapeConfig CRD
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 206
weight: 257
toc: true
title: Storage
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 207
weight: 258
toc: true
title: Strategic Merge Patch
menu:

View File

@@ -1,5 +1,5 @@
---
weight: 155
weight: 251
toc: true
title: Admission webhook
menu:
@@ -21,7 +21,7 @@ The admission webhook service is able to
* Convert `AlertmanagerConfig` objects between `v1alpha1` and `v1beta1` versions.
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)
on your cluster.

View File

@@ -176,7 +176,7 @@ Apache License
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
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.
See the License for the specific language governing permissions and
limitations under the License.

View File

@@ -1,3 +1,15 @@
---
weight: 506
toc: true
title: Release
menu:
docs:
parent: community
lead: ""
images: []
draft: false
---
# 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.

View File

@@ -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:
* Test cases serve as documentation, providing insights into the expected behavior of the software.

View File

@@ -1,3 +1,15 @@
---
weight: 505
toc: true
title: Code of Conduct
menu:
docs:
parent: community
lead: ""
images: []
draft: false
---
## Community Code of Conduct
### Contributor Code of Conduct