From 91822d37d878b28168cc7d037708eb6fc8cd4903 Mon Sep 17 00:00:00 2001 From: Ashwin Sriram <116557116+AshwinSriram11@users.noreply.github.com> Date: Tue, 2 Jul 2024 17:38:03 +0530 Subject: [PATCH] chore: Docs Restructuring (#6650) --- CONTRIBUTING.md | 4 ++-- DCO | 12 ++++++++++++ Documentation/compatibility.md | 4 ++-- Documentation/design.md | 4 ++-- Documentation/high-availability.md | 2 +- Documentation/operator.md | 2 +- Documentation/rbac-crd.md | 2 +- Documentation/rbac.md | 2 +- Documentation/thanos.md | 2 +- Documentation/troubleshooting.md | 2 +- Documentation/user-guides/alerting.md | 2 +- Documentation/user-guides/getting-started.md | 2 +- Documentation/user-guides/prometheus-agent.md | 4 ++-- Documentation/user-guides/scrapeconfig.md | 2 +- Documentation/user-guides/storage.md | 2 +- Documentation/user-guides/strategic-merge-patch.md | 2 +- Documentation/user-guides/webhook.md | 4 ++-- LICENSE | 3 +-- RELEASE.md | 12 ++++++++++++ TESTING.md | 12 ++++++++++++ code-of-conduct.md | 12 ++++++++++++ 21 files changed, 70 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 751e244db..e60fd0f6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: [] diff --git a/DCO b/DCO index 716561d5d..9d1e477c2 100644 --- a/DCO +++ b/DCO @@ -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 diff --git a/Documentation/compatibility.md b/Documentation/compatibility.md index b69e8d2ff..21b24df82 100644 --- a/Documentation/compatibility.md +++ b/Documentation/compatibility.md @@ -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 diff --git a/Documentation/design.md b/Documentation/design.md index 253da64aa..ff2c78157 100644 --- a/Documentation/design.md +++ b/Documentation/design.md @@ -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. diff --git a/Documentation/high-availability.md b/Documentation/high-availability.md index c82d5b2c5..dfc591965 100644 --- a/Documentation/high-availability.md +++ b/Documentation/high-availability.md @@ -1,5 +1,5 @@ --- -weight: 203 +weight: 256 toc: true title: High Availability menu: diff --git a/Documentation/operator.md b/Documentation/operator.md index 8b826158b..bff6912bd 100644 --- a/Documentation/operator.md +++ b/Documentation/operator.md @@ -1,5 +1,5 @@ --- -weight: 212 +weight: 259 toc: false title: CLI reference menu: diff --git a/Documentation/rbac-crd.md b/Documentation/rbac-crd.md index cedf83be8..8fb0753f4 100644 --- a/Documentation/rbac-crd.md +++ b/Documentation/rbac-crd.md @@ -1,5 +1,5 @@ --- -weight: 205 +weight: 255 toc: true title: RBAC for CRDs menu: diff --git a/Documentation/rbac.md b/Documentation/rbac.md index 3e6579b05..7b7ea3b4c 100644 --- a/Documentation/rbac.md +++ b/Documentation/rbac.md @@ -1,5 +1,5 @@ --- -weight: 204 +weight: 254 toc: true title: RBAC menu: diff --git a/Documentation/thanos.md b/Documentation/thanos.md index 766cc1856..d886901d0 100644 --- a/Documentation/thanos.md +++ b/Documentation/thanos.md @@ -1,5 +1,5 @@ --- -weight: 208 +weight: 253 toc: true title: Thanos menu: diff --git a/Documentation/troubleshooting.md b/Documentation/troubleshooting.md index bd8b8e77c..212076c31 100644 --- a/Documentation/troubleshooting.md +++ b/Documentation/troubleshooting.md @@ -1,5 +1,5 @@ --- -weight: 209 +weight: 260 toc: true title: Troubleshooting menu: diff --git a/Documentation/user-guides/alerting.md b/Documentation/user-guides/alerting.md index 505c25df9..83e139e3f 100644 --- a/Documentation/user-guides/alerting.md +++ b/Documentation/user-guides/alerting.md @@ -1,5 +1,5 @@ --- -weight: 152 +weight: 202 toc: true title: Alerting menu: diff --git a/Documentation/user-guides/getting-started.md b/Documentation/user-guides/getting-started.md index 11e69c703..2b1bfe53a 100644 --- a/Documentation/user-guides/getting-started.md +++ b/Documentation/user-guides/getting-started.md @@ -1,5 +1,5 @@ --- -weight: 151 +weight: 201 toc: true title: Getting Started menu: diff --git a/Documentation/user-guides/prometheus-agent.md b/Documentation/user-guides/prometheus-agent.md index c73154a33..4f80e48c2 100644 --- a/Documentation/user-guides/prometheus-agent.md +++ b/Documentation/user-guides/prometheus-agent.md @@ -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]({{}}) to learn how to monitor applications running on Kubernetes. +Continue with the [Getting Started page]({{}}) to learn how to monitor applications running on Kubernetes. diff --git a/Documentation/user-guides/scrapeconfig.md b/Documentation/user-guides/scrapeconfig.md index 709c91f01..df858cb3d 100644 --- a/Documentation/user-guides/scrapeconfig.md +++ b/Documentation/user-guides/scrapeconfig.md @@ -1,5 +1,5 @@ --- -weight: 154 +weight: 203 toc: true title: ScrapeConfig CRD menu: diff --git a/Documentation/user-guides/storage.md b/Documentation/user-guides/storage.md index e6b0c11f4..e1592954f 100644 --- a/Documentation/user-guides/storage.md +++ b/Documentation/user-guides/storage.md @@ -1,5 +1,5 @@ --- -weight: 206 +weight: 257 toc: true title: Storage menu: diff --git a/Documentation/user-guides/strategic-merge-patch.md b/Documentation/user-guides/strategic-merge-patch.md index 336882872..e29746e69 100644 --- a/Documentation/user-guides/strategic-merge-patch.md +++ b/Documentation/user-guides/strategic-merge-patch.md @@ -1,5 +1,5 @@ --- -weight: 207 +weight: 258 toc: true title: Strategic Merge Patch menu: diff --git a/Documentation/user-guides/webhook.md b/Documentation/user-guides/webhook.md index 79c29dbfc..a8c0af31a 100644 --- a/Documentation/user-guides/webhook.md +++ b/Documentation/user-guides/webhook.md @@ -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. diff --git a/LICENSE b/LICENSE index e06d20818..74e6ec696 100644 --- a/LICENSE +++ b/LICENSE @@ -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. - diff --git a/RELEASE.md b/RELEASE.md index ad783e78c..9e7ec429d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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. diff --git a/TESTING.md b/TESTING.md index 895982bb6..0b4c6fc78 100644 --- a/TESTING.md +++ b/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: * Test cases serve as documentation, providing insights into the expected behavior of the software. diff --git a/code-of-conduct.md b/code-of-conduct.md index 97b47b0ce..10a5dea02 100644 --- a/code-of-conduct.md +++ b/code-of-conduct.md @@ -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