fix: Dead links (#63)

tomkerkhove · web-flow · commit 98ea44d3735a · 2024-06-05T23:03:41.000+02:00
diff --git a/docs/deployment/index.md b/docs/deployment/index.md
@@ -2,8 +2,8 @@
 
 Here is an overview of the Promitor agents you can deploy:
 
-- [Deploying Promitor Scraper](scraper/)
-- [Deploying Promitor Resource Discovery](resource-discovery/)
+- [Deploying Promitor Scraper](scraper/index.md)
+- [Deploying Promitor Resource Discovery](resource-discovery/index.md)
 
 ## Image Tagging Strategy
 
@@ -27,4 +27,4 @@ You can also pin to a specific digest of an image to ensure that you are running
 the same image across your infrastructure. However, you will not receive security
 patches unless you use a tool like [Renovate to keep them up-to-date](https://www.mend.io/free-developer-tools/blog/overcoming-dockers-mutable-image-tags/).
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/deployment/resource-discovery/kubernetes.md b/docs/deployment/resource-discovery/kubernetes.md
@@ -98,4 +98,4 @@ telemetry:
 
 You can easily deploy it by passing the file through `--values` during installation.
 
-[&larr; back](/)
+[&larr; back](../../index.md)
diff --git a/docs/deployment/scraper/kubernetes.md b/docs/deployment/scraper/kubernetes.md
@@ -30,7 +30,7 @@ https://hub.helm.sh/charts/promitor/promitor-ag...      1.6.0           1.6.1
 To use this, you will need to provide parameters [via `--set` or `--values`](https://helm.sh/docs/using_helm/#customizing-the-chart-before-installing).
 Included here are the values that correspond with the local environment variables.
 In addition to these, you will need a metric declaration file as described in
-[Metric Declaration](/configuration/metrics).
+[Metric Declaration](./../../scraping/overview.md).
 
 ```yaml
 azureMetadata:
@@ -86,4 +86,4 @@ with this command:
                --values /path/to/helm-configuration.yaml
 ```
 
-[&larr; back](/)
+[&larr; back](../../index.md)
diff --git a/docs/faq.md b/docs/faq.md
@@ -17,7 +17,7 @@ Azure Storage queues.
 
 You can configure the dimension(s) you are interested in via
 `azureMetricConfiguration.dimensions`, for more information see
-our ['Metrics Declaration' page](/scraping/overview/#metrics).
+our ['Metrics Declaration' page](scraping/overview.md#metrics).
 
 However, you can only use it with metrics in Azure Monitor that support this,
 for a complete overview we recommend reading the
@@ -26,7 +26,7 @@ for a complete overview we recommend reading the
 ## How does Promitor handle deleted resources?
 
 The approach depends if you are using declarative metrics or resource discovery but we highly recommend to
- **enable Prometheus metric timestamps** in [our runtime configuration](/configuration/v2.x/runtime/scraper/#prometheus-scraping-endpoint)
+ **enable Prometheus metric timestamps** in [our runtime configuration](scraping/runtime-configuration.md#prometheus-scraping-endpoint)
   to indicate how old the metric is.
 
 ### When using declarative metrics
@@ -58,7 +58,7 @@ We support `Global` (default), `China`, `UsGov` & `Germany` Azure clouds.
 
 This can be configured in the metric configuration under `azureMetadata`.
 
-For more information see our ['Metric Configuration' page](/configuration/v1.x/metrics/#metrics).
+For more information see our ['Metric Configuration' page](scraping/overview.md).
 
 ## Why does Azure Blob & File Storage only report account-level information?
 
@@ -72,7 +72,7 @@ As part of [#450](https://github.com/tomkerkhove/promitor/issues/450) &
 When Promitor is unable to find a metric for a multi-dimensional metric, it will report `unknown` for the dimension
  label given it was not able to determine what the dimension value is due to the lack of metrics.
 
-You can read more about it in our [Prometheus sink documentation](/configuration/v2.x/runtime/scraper/#what-happens-when-metrics-are-unavailable-for-multi-dimensional-metrics).
+You can read more about it in our [Prometheus sink documentation](scraping/runtime-configuration.md#what-happens-when-metrics-are-unavailable-for-multi-dimensional-metrics).
 
 ## What operating systems are supported?
 
diff --git a/docs/how-it-works.md b/docs/how-it-works.md
@@ -39,7 +39,7 @@ You can easily start discovering resources automatically:
 
 1. Declare resource discovery groups ([link](resource-discovery/declaring-resource-discovery-groups.md))
 2. Deploy Promitor Resource Discovery ([link](deployment/resource-discovery/index.md))
-3. Configure Promitor Scraper to use resource discovery ([link](scraping/overview.md#using-resource-discovery))
+3. Configure Promitor Scraper to use resource discovery ([link](https://promitor.io/concepts/#using-resource-discovery))
 4. Deploy Promitor Scraper ([link](deployment/scraper/index.md))
 
 ## What components do agents provide?
@@ -53,4 +53,4 @@ Here's a detailed overview:
 
 _(*) Resources are still discovered synchronously but this will be implemented in Promitor Resource Discovery v0.2._
 
-[&larr; back](/)
+[&larr; back](index.md)
diff --git a/docs/operations/index.md b/docs/operations/index.md
@@ -14,6 +14,6 @@ Here is an overview of how you can operate Promitor.
     - [Consuming the System endpoint](system.md#consuming-the-system-endpoint)
     - [Exploring our REST APIs](system.md#exploring-our-rest-apis)
 - [Integrations](integrations.md)
-    - [Azure Resource Manager API - Consumption & Throttling](integrations.md#azure-resource-manager-api---consumption--throttling)
+    - [Azure Resource Manager API - Consumption & Throttling](integrations.md#azure-resource-manager-api-consumption-throttling)
     - [Azure Resource Graph](integrations.md#azure-resource-graph)
     - [Azure Monitor](integrations.md#azure-monitor)
diff --git a/docs/operations/integrations.md b/docs/operations/integrations.md
@@ -72,6 +72,6 @@ Promitor interacts with Azure Monitor API to scrape all the required metrics.
 
 During troubleshooting it can be interesting to gain insights on what the API returns, for which you can opt-in.
 
-You can opt-in for it by configuring the [runtime telemetry](/configuration/v2.x/runtime/scraper#azure-monitor).
+You can opt-in for it by configuring the [runtime telemetry](./../scraping/runtime-configuration.md#azure-monitor).
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/operations/performance.md b/docs/operations/performance.md
@@ -44,7 +44,7 @@ promitor_runtime_http_request_duration_seconds_count{status_code="200",method="G
 Every Promitor agent supports exposing Prometheus metrics:
 
 - **Resource Discovery agent** - Exposed on `/metrics` endpoint
-- **Scraper agent** - Exposed through Prometheus metric sink ([docs](/configuration/v2.x/runtime/scraper#prometheus-scraping-endpoint))
+- **Scraper agent** - Exposed through Prometheus metric sink ([docs](./../scraping/runtime-configuration.md#prometheus-scraping-endpoint))
 
 ## Scraping Azure Monitor
 
diff --git a/docs/resource-discovery/runtime-configuration.md b/docs/resource-discovery/runtime-configuration.md
@@ -202,4 +202,4 @@ server:
 An environment variable called `PROMITOR_YAML_OVERRIDE_server__httpPort` can be
 provided which specifies the new port.
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/scraping/overview.md b/docs/scraping/overview.md
@@ -183,4 +183,4 @@ metrics:
     - name: service-bus-landscape
 ```
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/scraping/runtime-configuration.md b/docs/scraping/runtime-configuration.md
@@ -393,4 +393,4 @@ server:
 An environment variable called `PROMITOR_YAML_OVERRIDE_server__httpPort` can be
 provided which specifies the new port.
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/security/azure-authentication.md b/docs/security/azure-authentication.md
@@ -75,4 +75,4 @@ subscription, resource group and/or resources that will be queried.
 
 More information can be found [here](https://docs.microsoft.com/en-us/azure/governance/resource-graph/overview#permissions-in-azure-resource-graph).
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/walkthroughs/migrate-from-1.x-to-2.x.md b/docs/walkthroughs/migrate-from-1.x-to-2.x.md
@@ -75,4 +75,4 @@ Our OpenAPI 3.0 docs are available on:
 - Swagger UI on `/api/docs`
 - Raw documentation on `/api/v1/docs.json`
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md b/docs/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md
@@ -357,4 +357,4 @@ create the dashboard and view metrics about your AKS cluster.
 
 To delete all the resources used in this tutorial, run `az group delete --name PromitorRG`.
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/docs/walkthroughs/use-promitor-with-managed-identity.md b/docs/walkthroughs/use-promitor-with-managed-identity.md
@@ -483,4 +483,4 @@ demo_queue_size{resource_group="ammdocs",subscription_id="xxxxx-xxxxx-xxxxx-xxxx
 
 To delete all the resources used in this tutorial, run `az group delete --name $RG_NAME`.
 
-[&larr; back](/)
+[&larr; back](../index.md)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -118,8 +118,8 @@ markdown_extensions:
   - meta
   - md_in_html
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - toc:
       permalink: true
   - pymdownx.highlight:

Original file line number	Diff line number	Diff line change
`@@ -98,4 +98,4 @@ telemetry:`
`98`	`98`
`99`	`99`	You can easily deploy it by passing the file through `--values` during installation.
`100`	`100`
`101`		`-[← back](/)`
	`101`	`+[← back](../../index.md)`