[editorial] Rename docs files and folders: replace "_" by "-"; add ch…

…eck (#177)

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

.github/workflows/checks.yml

@@ -16,6 +16,9 @@ jobs:
     - name: install dependencies
       run: npm install
 
+    - name: Check file and folder names
+      run: make check-file-and-folder-names-in-docs
+
     - name: run markdownlint
       run: make markdownlint
 

Makefile

@@ -12,7 +12,17 @@ SEMCONVGEN_VERSION=0.18.0
 
 # TODO: add `yamllint` step to `all` after making sure it works on Mac.
 .PHONY: all
-all: install-tools markdownlint markdown-link-check misspell table-check schema-check
+all: install-tools markdownlint markdown-link-check misspell table-check schema-check \
+		 check-file-and-folder-names-in-docs
+
+.PHONY: check-file-and-folder-names-in-docs
+check-file-and-folder-names-in-docs:
+	@found=`find docs -name '*_*'`; \
+	if [ -n "$$found" ]; then \
+		echo "Error: Underscores found in doc file or folder names, use hyphens instead:"; \
+		echo $$found; \
+		exit 1; \
+	fi
 
 $(MISSPELL):
 	cd $(TOOLS_DIR) && go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell

docs/resource/README.md

@@ -198,7 +198,7 @@ Attributes defining a running environment (e.g. Operating System, Cloud, Data Ce
 - [Device](./device.md)
 - [Cloud](./cloud.md)
 - Deployment:
-  - [Deployment Environment](./deployment_environment.md)
+  - [Deployment Environment](./deployment-environment.md)
   - [Kubernetes](./k8s.md)
 - [Browser](./browser.md)
 
@@ -216,14 +216,14 @@ the exact version used to identify an artifact. This may be a semantic version,
 
 Attributes that are only applicable to resources from a specific cloud provider. Currently, these
 resources can only be defined for providers listed as a valid `cloud.provider` in
-[Cloud](./cloud.md) and below. Provider-specific attributes all reside in the `cloud_provider` directory.
+[Cloud](./cloud.md) and below. Provider-specific attributes all reside in the `cloud-provider` directory.
 Valid cloud providers are:
 
 - [Alibaba Cloud](https://www.alibabacloud.com/) (`alibaba_cloud`)
-- [Amazon Web Services](https://aws.amazon.com/) ([`aws`](cloud_provider/aws/README.md))
-- [Google Cloud Platform](https://cloud.google.com/) ([`gcp`](cloud_provider/gcp/README.md))
+- [Amazon Web Services](https://aws.amazon.com/) ([`aws`](cloud-provider/aws/README.md))
+- [Google Cloud Platform](https://cloud.google.com/) ([`gcp`](cloud-provider/gcp/README.md))
 - [Microsoft Azure](https://azure.microsoft.com/) (`azure`)
 - [Tencent Cloud](https://www.tencentcloud.com/) (`tencent_cloud`)
-- [Heroku dyno](./cloud_provider/heroku.md)
+- [Heroku dyno](./cloud-provider/heroku.md)
 
 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

docs/resource/cloud_provider/gcp/README.md → docs/resource/cloud-provider/gcp/README.md

@@ -9,7 +9,7 @@ provider (like account ID, operating system, etc), it belongs in the parent
 
 ## Services
 
-- [Cloud Run](./cloud_run.md)
+- [Cloud Run](./cloud-run.md)
 - [Compute Engine](./gce.md)
 
 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md