Merge pull request #7229 from AshwinSriram11/folders

Reorganize Documentation Folder

Documentation/getting-started/design.md

@@ -29,7 +29,7 @@ For a better understanding of all these custom resources, let us classify them i
 
 ### Instance-Based Resources
 
-![Instances based resources](img/instance-based-resources.png)
+![Instances based resources](../img/instance-based-resources.png)
 
 Instance-based resources are used to manage the deployment and lifecycle of different components in the Prometheus ecosystem, as shown in the above figure. Let us look into the features of each of these custom resources:
 
@@ -53,7 +53,7 @@ The `Prometheus Agent` CRD sets up a [Prometheus Agent](https://prometheus.io/bl
 
 Config-based resources focus on managing the monitoring of resources and scraping metrics within a Kubernetes cluster. They define how metrics are collected, processed, and managed, rather than managing the deployment of the monitoring components themselves. For a clear picture, let us look at the relation of config-based resources with instance based resources.
 
-![Config based resources](img/config-based-resources.png)
+![Config based resources](../img/config-based-resources.png)
 
 The `Prometheus` and `PrometheusAgent` CRDs use the `podMonitorSelector`, `serviceMonitorSelector`, `probeSelector`, and `scrapeConfigSelector` fields to determine which `ServiceMonitor`, `PodMonitor`, `Probe`, and `ScrapeConfig` configurations should be included in the `Prometheus` and `PrometheusAgent` instances for scraping.
 
@@ -75,12 +75,12 @@ The `ScrapeConfig` CRD allows you to define how Prometheus should discover and s
 
 #### AlertmanagerConfig
 
-![AlertmanagerConfig](img/alertmanager-config.png)
+![AlertmanagerConfig](../img/alertmanager-config.png)
 
 The `AlertmanagerConfig` CRD allows us to configure `Alertmanager` instances in a Kubernetes cluster. It specifies subsections of the Alertmanager configuration, enabling the routing of alerts to custom receivers and the setting of inhibition rules.
 
 #### PrometheusRule
 
-![Prometheus Rule](img/prometheus-rule.png)
+![Prometheus Rule](../img/prometheus-rule.png)
 
 The `PrometheusRule` CRD allows the definition of alerting and recording rules to be consumed by Prometheus or Thanos Ruler instances. Alerts and recording rules are reconciled by the Operator and dynamically loaded without requiring a restart of Prometheus or Thanos Ruler.

Documentation/platform/platform-guide.md

@@ -11,7 +11,7 @@ draft: false
 description: Getting started page for Platform Guide
 ---
 
-This guide assumes you have a basic understanding of the Prometheus Operator. If you are new to it, please start with the [Introduction]({{< ref "introduction.md" >}}) page before proceeding. This guide will walk you through deploying Prometheus and Alertmanager instances.
+This guide assumes you have a basic understanding of the Prometheus Operator. If you are new to it, please start with the [Introduction]({{<ref "introduction.md">}}) page before proceeding. This guide will walk you through deploying Prometheus and Alertmanager instances.
 
 ## Deploying Prometheus
 
@@ -150,7 +150,7 @@ spec:
 Once the Service is created, the Alertmanager web server is available under the
 node's IP address on port `30903`.
 
-> Note: Exposing the Alertmanager web server this way may not be an applicable solution. Read more about the possible options in the [Ingress guide]({{< ref "exposing-prometheus-and-alertmanager.md" >}}).
+> Note: Exposing the Alertmanager web server this way may not be an applicable solution. Read more about the possible options in the [Ingress guide]({{<ref "exposing-prometheus-and-alertmanager.md">}}).
 
 ### Configuring Alertmanager in Prometheus
 

Documentation/platform/troubleshooting.md

@@ -70,7 +70,7 @@ A common problem related to `ServiceMonitor` identification by Prometheus is rel
 
 <!-- do not change this link without verifying that the image will display correctly on https://prometheus-operator.dev -->
 
-![flow diagram](/img/custom-metrics-elements.png)
+![flow diagram](../img/custom-metrics-elements.png)
 
 Note: The `ServiceMonitor` references a `Service` (not a `Deployment`, or a `Pod`), by labels *and* by the port name in the `Service`. This *port name* is optional in Kubernetes, but must be specified for the `ServiceMonitor` to work. It is not the same as the port name on the `Pod` or container, although it can be.
 

Makefile

@@ -281,16 +281,16 @@ example/admission-webhook: scripts/generate/vendor scripts/generate/admission-we
 example/alertmanager-crd-conversion: scripts/generate/vendor scripts/generate/conversion-webhook-patch-for-alermanagerconfig-crd.jsonnet $(shell find jsonnet -type f)
 	scripts/generate/build-conversion-webhook-patch-for-alermanagerconfig-crd.sh
 
-FULLY_GENERATED_DOCS = Documentation/api.md Documentation/compatibility.md Documentation/operator.md
+FULLY_GENERATED_DOCS = Documentation/api-reference/api.md Documentation/getting-started/compatibility.md Documentation/platform/operator.md
 
-Documentation/operator.md: operator
+Documentation/platform/operator.md: operator
 	$(MDOX_BINARY) fmt $@
 
-Documentation/compatibility.md: pkg/operator/defaults.go
+Documentation/getting-started/compatibility.md: pkg/operator/defaults.go
 	$(MDOX_BINARY) fmt $@
 
-Documentation/api.md: $(TYPES_V1_TARGET) $(TYPES_V1ALPHA1_TARGET) $(TYPES_V1BETA1_TARGET)
-	GODEBUG=$(GODEBUG) $(API_DOC_GEN_BINARY) -api-dir "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/" -config "$(PWD)/scripts/docs/config.json" -template-dir "$(PWD)/scripts/docs/templates" -out-file "$(PWD)/Documentation/api.md"
+Documentation/api-reference/api.md: $(TYPES_V1_TARGET) $(TYPES_V1ALPHA1_TARGET) $(TYPES_V1BETA1_TARGET)
+	GODEBUG=$(GODEBUG) $(API_DOC_GEN_BINARY) -api-dir "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/" -config "$(PWD)/scripts/docs/config.json" -template-dir "$(PWD)/scripts/docs/templates" -out-file "$(PWD)/Documentation/api-reference/api.md"
 
 ##############
 # Formatting #

README.md

@@ -181,7 +181,7 @@ the maintainers of the project found in the [MAINTAINERS.md](MAINTAINERS.md) fil
 
 ## Troubleshooting
 
-Check the [troubleshooting documentation](Documentation/troubleshooting.md) for
+Check the [troubleshooting documentation](Documentation/platform/troubleshooting.md) for
 common issues and frequently asked questions (FAQ).
 
 ## Acknowledgements