fix: Automatically detect broken links (#25

* ci: Automatically detect broken links

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

* Update ci.yml

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

* Update ci.yml

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

* Update ci.yml

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

* Update ci.yml

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

* Update ci.yml

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

* Fix dead links

* Move exclude

* Fix last link

* Remove example site

* Remove dead links

---------

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches:
+     - main
+  pull_request:
+    branches:
+     - main
+
+jobs:
+  broken_links:
+    name: Detect Broken Links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1.6.1
+        with:
+          args: --verbose --no-progress 'docs/**/*.md' --exclude-loopback --exclude 'docs/themes/**/*.md'
+          format: markdown
+          jobSummary: true
+          fail: true

docs/config/_default/menus.en.toml

@@ -55,27 +55,27 @@ url = "legal"
 # footer menu middle
 [[footer_middle]]
 name = "Supported Azure Services"
-url = "https://docs.promitor.io/configuration/v2.x/metrics/"
+url = "https://docs.promitor.io/latest/scraping/overview/"
 weight = 1
 
 [[footer_middle]]
 name = "Metric Sinks"
-url = "https://docs.promitor.io/configuration/v2.x/runtime/scraper#metric-sinks"
+url = "https://docs.promitor.io/latest/scraping/runtime-configuration/#metric-sinks"
 weight = 2
 
 [[footer_middle]]
 name = "Deployment"
-url = "https://docs.promitor.io/deployment"
+url = "https://docs.promitor.io/latest/deployment/"
 weight = 3
 
 [[footer_middle]]
 name = "Operations"
-url = "https://docs.promitor.io/operations"
+url = "https://docs.promitor.io/latest/operations/"
 weight = 4
 
 [[footer_middle]]
 name = "Security"
-url = "https://docs.promitor.io/configuration/v2.x/azure-authentication"
+url = "https://docs.promitor.io/latest/security/azure-authentication/"
 weight = 5
 
 # footer menu right

docs/content/english/_index.md

@@ -71,7 +71,7 @@ service:
       button:
         enable : true
         label : "Check it out"
-        link : "https://docs.promitor.io/configuration/v2.x/runtime/scraper#metric-sinks"
+        link : "https://docs.promitor.io/latest/scraping/runtime-configuration/#metric-sinks"
 
     # service item loop
     - title : "Trusted By Others"

docs/content/english/concepts/_index.md

@@ -43,10 +43,10 @@ Here's an overview of how they work together:
 
 You can easily start discovering resources automatically:
 
-1. Declare resource discovery groups ([link](https://docs.promitor.io/configuration/v2.x/resource-discovery))
-2. Deploy Promitor Resource Discovery ([link](https://docs.promitor.io/deployment/resource-discovery))
-3. Configure Promitor Scraper to use resource discovery ([link](https://docs.promitor.io/configuration/v2.x/runtime/scraper#using-resource-discovery))
-4. Deploy Promitor Scraper ([link](https://docs.promitor.io/deployment/scraper))
+1. Declare resource discovery groups ([link](https://docs.promitor.io/latest/resource-discovery/declaring-resource-discovery-groups/))
+2. Deploy Promitor Resource Discovery ([link](https://docs.promitor.io/latest/deployment/resource-discovery/kubernetes/))
+3. Configure Promitor Scraper to use resource discovery ([link](https://docs.promitor.io/latest/scraping/runtime-configuration/#using-resource-discovery))
+4. Deploy Promitor Scraper ([link](https://docs.promitor.io/latest/deployment/scraper/kubernetes/))
 
 ## What components do agents provide?
 

docs/content/english/faq/_index.md

@@ -34,7 +34,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](https://docs.promitor.io/configuration/v2.x/metrics/#metrics).
+For more information see our ['Metric Configuration' page](https://docs.promitor.io/latest/scraping/overview/#metrics).
 {{</ faq >}}
 
 {{< faq "Why do Azure Blob & File Storage only report account-level information?" >}}

docs/content/english/get-started/_index.md

@@ -8,7 +8,7 @@ draft: false
 
 We provide a variety of walkthroughs to get you up and running with Promitor:
 
-- Deploying Promitor, Prometheus, and Grafana on an Azure Kubernetes Service Cluster ([link](https://docs.promitor.io/walkthrough/scrape-promitor-with-prometheus-on-azure-kubernetes-service))
-- Using Managed Identity with Promitor on an Azure Kubernetes Service Cluster ([link](https://docs.promitor.io/walkthrough/use-promitor-with-managed-identity))
+- Deploying Promitor, Prometheus, and Grafana on an Azure Kubernetes Service Cluster ([link](https://docs.promitor.io/latest/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service/))
+- Using Managed Identity with Promitor on an Azure Kubernetes Service Cluster ([link](https://docs.promitor.io/latest/walkthroughs/use-promitor-with-managed-identity/))
 
 Learn more about Promitor in our [documentation](https://docs.promitor.io/).

docs/themes/bigspring/README.md

@@ -78,8 +78,3 @@ Copyright © 2020 Designed by [Themefisher](https://themefisher.com) & Devel
 **Code License:** Released under the [MIT](https://github.com/themefisher/bigspring-hugo-startup-theme/blob/master/LICENSE) license.
 
 **Image license:** The images are only for demonstration purposes. They have their own licence, we don't have permission to share those image.
-## Premium Themes
-
-| [![Mega-Bundle-HUGO](https://gethugothemes.com/wp-content/uploads/edd/2019/09/Mega-Bundle-HUGO.png)](https://themefisher.com/products/hugo-mega-bundle/) | [![](https://gethugothemes.com/wp-content/uploads/edd/2020/09/Copper-hugo-sass-landingpage.jpg)](https://gethugothemes.com/products/copper/) | [![redlab](https://gethugothemes.com/wp-content/uploads/edd/2019/09/redlab-hugo-thumbnail.jpg)](https://gethugothemes.com/products/redlab-hugo/) |
-|:---:|:---:|:---:|
-| **Hugo Mega Bundle**  | **Copper**  | **Red Lab**  |