Add linkchecker + fix all broken links (#469)

* Add linkchecker + fix all broken links Fixes #468 * Fix links!
grafana · Apr 28, 2022 · 3b68019 · 3b68019
1 parent 975d1df
commit 3b68019
Show file tree

Hide file tree

Showing 16 changed files with 40 additions and 20 deletions.
diff --git a/.drone/drone.jsonnet b/.drone/drone.jsonnet
@@ -1,6 +1,7 @@
 local grafanaVersions = ['8.5.0', '8.4.7', '8.3.7', '8.2.7', '7.5.15'];
 local images = {
   go: 'golang:1.18',
+  python: 'python:3.9-alpine',
   lint: 'golangci/golangci-lint',
   grafana(version): 'grafana/grafana:' + version,
 };
@@ -68,6 +69,14 @@ local pipeline(name, steps, services=[]) = {
           'fi',
         ],
       },
+      {
+        name: 'check for broken links',
+        image: images.python,
+        commands: [
+          'pip3 install linkchecker',
+          'linkchecker --config ./.linkcheckerrc docs/',
+        ],
+      },
     ]
   ),
 

diff --git a/.drone/drone.yml b/.drone/drone.yml
@@ -38,6 +38,11 @@ steps:
   - fi
   image: golang:1.18
   name: check for drift
+- commands:
+  - pip3 install linkchecker
+  - linkchecker --config ./.linkcheckerrc docs/
+  image: python:3.9-alpine
+  name: check for broken links
 trigger:
   branch:
   - master
@@ -308,6 +313,6 @@ workspace:
   path: /drone/terraform-provider-grafana
 ---
 kind: signature
-hmac: 2525048a966617acb86ea8f67062ceed15fb03290ebfc01f2f089447dbcee09d
+hmac: 39c0a8d2ccf04e5464b044ebf859ff6455638cb5e40dd3ad152c5d4c4fb78862
 
 ...
diff --git a/.linkcheckerrc b/.linkcheckerrc
@@ -0,0 +1,5 @@
+[filtering]
+checkextern=1
+
+[MarkdownCheck]
+filename_re=.*\.md
diff --git a/GNUmakefile b/GNUmakefile
@@ -52,6 +52,9 @@ drone:
 	drone lint .drone/drone.yml
 	drone sign --save grafana/terraform-provider-grafana .drone/drone.yml
 
+linkcheck:
+	docker run -it --entrypoint sh -v "$$PWD:$$PWD" -w "$$PWD" python:3.9-alpine -c "pip3 install linkchecker && linkchecker --config .linkcheckerrc docs"
+
 build:
 	go build -o ${BINARY}
 

diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md
@@ -3,14 +3,14 @@
 page_title: "grafana_user Data Source - terraform-provider-grafana"
 subcategory: ""
 description: |-
-  Official documentation https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/HTTP API https://grafana.com/docs/grafana/latest/http_api/user/
+  Official documentation https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/HTTP API https://grafana.com/docs/grafana/latest/http_api/user/
   This data source uses Grafana's admin APIs for reading users which
   does not currently work with API Tokens. You must use basic auth.
 ---
 
 # grafana_user (Data Source)
 
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/)
 
 This data source uses Grafana's admin APIs for reading users which

diff --git a/docs/index.md b/docs/index.md
@@ -190,7 +190,7 @@ This can be a Grafana API key, basic auth `username:password`, or a
 
 ### `cloud_api_key`
 
-An API key created on the [Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/cloud-portal/create-api-key/).
+An API key created on the [Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/reference/create-api-key/).
 
 ### `sm_access_token`
 
@@ -208,7 +208,7 @@ curl \
 ```
 
 `GRAFANA_CLOUD_API_KEY` is an API key created on the
-[Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/cloud-portal/create-api-key/).
+[Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/reference/create-api-key/).
 It must have the `MetricsPublisher` role.
 
 `SM_API_URL` is the URL of the Synthetic Monitoring API.

diff --git a/docs/resources/oncall_route.md b/docs/resources/oncall_route.md
@@ -3,12 +3,11 @@
 page_title: "grafana_oncall_route Resource - terraform-provider-grafana"
 subcategory: ""
 description: |-
-  Official documentation https://grafana.com/docs/grafana-cloud/oncall/routes/HTTP API https://grafana.com/docs/grafana-cloud/oncall/oncall-api-reference/routes/
+  HTTP API https://grafana.com/docs/grafana-cloud/oncall/oncall-api-reference/routes/
 ---
 
 # grafana_oncall_route (Resource)
 
-* [Official documentation](https://grafana.com/docs/grafana-cloud/oncall/routes/)
 * [HTTP API](https://grafana.com/docs/grafana-cloud/oncall/oncall-api-reference/routes/)
 
 ## Example Usage

diff --git a/docs/resources/organization.md b/docs/resources/organization.md
@@ -3,12 +3,12 @@
 page_title: "grafana_organization Resource - terraform-provider-grafana"
 subcategory: ""
 description: |-
-  Official documentation https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-orgs/HTTP API https://grafana.com/docs/grafana/latest/http_api/org/
+  Official documentation https://grafana.com/docs/grafana/latest/administration/manage-organizations/HTTP API https://grafana.com/docs/grafana/latest/http_api/org/
 ---
 
 # grafana_organization (Resource)
 
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-orgs/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-organizations/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/org/)
 
 ## Example Usage

diff --git a/docs/resources/team.md b/docs/resources/team.md
@@ -3,12 +3,12 @@
 page_title: "grafana_team Resource - terraform-provider-grafana"
 subcategory: ""
 description: |-
-  Official documentation https://grafana.com/docs/grafana/latest/manage-users/manage-teams/HTTP API https://grafana.com/docs/grafana/latest/http_api/team/
+  Official documentation https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-teams/HTTP API https://grafana.com/docs/grafana/latest/http_api/team/
 ---
 
 # grafana_team (Resource)
 
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/manage-teams/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-teams/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/team/)
 
 ## Example Usage

diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -3,14 +3,14 @@
 page_title: "grafana_user Resource - terraform-provider-grafana"
 subcategory: ""
 description: |-
-  Official documentation https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/HTTP API https://grafana.com/docs/grafana/latest/http_api/user/
+  Official documentation https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/HTTP API https://grafana.com/docs/grafana/latest/http_api/user/
   This resource uses Grafana's admin APIs for creating and updating users which
   does not currently work with API Tokens. You must use basic auth.
 ---
 
 # grafana_user (Resource)
 
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/)
 
 This resource uses Grafana's admin APIs for creating and updating users which

diff --git a/grafana/data_source_user.go b/grafana/data_source_user.go
@@ -12,7 +12,7 @@ import (
 func DatasourceUser() *schema.Resource {
 	return &schema.Resource{
 		Description: `
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/)
 
 This data source uses Grafana's admin APIs for reading users which

diff --git a/grafana/resource_oncall_route.go b/grafana/resource_oncall_route.go
@@ -12,7 +12,6 @@ import (
 func ResourceOnCallRoute() *schema.Resource {
 	return &schema.Resource{
 		Description: `
-* [Official documentation](https://grafana.com/docs/grafana-cloud/oncall/routes/)
 * [HTTP API](https://grafana.com/docs/grafana-cloud/oncall/oncall-api-reference/routes/)
 `,
 		Create: ResourceOnCallRouteCreate,

diff --git a/grafana/resource_organization.go b/grafana/resource_organization.go
@@ -38,7 +38,7 @@ func ResourceOrganization() *schema.Resource {
 	return &schema.Resource{
 
 		Description: `
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-orgs/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-organizations/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/org/)
 `,
 

diff --git a/grafana/resource_team.go b/grafana/resource_team.go
@@ -32,7 +32,7 @@ func ResourceTeam() *schema.Resource {
 	return &schema.Resource{
 
 		Description: `
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/manage-teams/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-teams/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/team/)
 `,
 

diff --git a/grafana/resource_user.go b/grafana/resource_user.go
@@ -15,7 +15,7 @@ func ResourceUser() *schema.Resource {
 	return &schema.Resource{
 
 		Description: `
-* [Official documentation](https://grafana.com/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/)
+* [Official documentation](https://grafana.com/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/)
 * [HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/)
 
 This resource uses Grafana's admin APIs for creating and updating users which

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -41,7 +41,7 @@ This can be a Grafana API key, basic auth `username:password`, or a
 
 ### `cloud_api_key`
 
-An API key created on the [Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/cloud-portal/create-api-key/).
+An API key created on the [Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/reference/create-api-key/).
 
 ### `sm_access_token`
 
@@ -59,7 +59,7 @@ curl \
 ```
 
 `GRAFANA_CLOUD_API_KEY` is an API key created on the
-[Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/cloud-portal/create-api-key/).
+[Grafana Cloud Portal](https://grafana.com/docs/grafana-cloud/reference/create-api-key/).
 It must have the `MetricsPublisher` role.
 
 `SM_API_URL` is the URL of the Synthetic Monitoring API.