Enable markdown-link-check (open-telemetry#541)

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

Author: bogdandrutu

.circleci/config.yml

@@ -7,24 +7,32 @@ jobs:
       - image: circleci/golang:1.12
     steps:
       - checkout
+      - run:
+          name: Misspell Install
+          command: make install-misspell
       - run:
           name: Misspell check
-          command: make precommit
+          command: make misspell
+
   markdownlint:
     docker:
-      - image: circleci/ruby:latest
+      - image: node:13
     steps:
       - checkout
       - run:
-          name: Install markdownlint
-          command: gem install mdl
+          name: Install Tools
+          command: |
+            make install-markdown-lint
+            make install-markdown-link-check
       - run:
-          name: Check markdownlint
-          command: mdl -c .mdlrc .
+          name: Run Tools
+          command: |
+            make markdown-lint
+            make enforce-markdown-link-check
 
 workflows:
   version: 2
-  build:
+  check-errors:
     jobs:
       - misspell
       - markdownlint

.markdownlint.yaml

@@ -0,0 +1,9 @@
+{
+  "default": true,
+  "MD024": { "allow_different_nesting": true },
+  "MD029": { "style": "ordered" },
+  "ul-style": false,  # MD004
+  "line-length": false,  # MD013
+  "no-inline-html": false,  # MD033
+  "fenced-code-language": false  # MD040
+}

.mdlrc

@@ -43,7 +43,7 @@ one that is needlessly restrictive and complex.
 Markdown files should be properly formatted before a pull request is sent out.
 In this repository we follow the
 [markdownlint rules](https://github.com/DavidAnson/markdownlint#rules--aliases)
-with some customizations. See [mdlstyle](.mdlstyle.rb) or
+with some customizations. See [markdownlint](.markdownlint.yaml) or
 [settings](.vscode/settings.json) for details.
 
 We highly encourage to use line breaks in markdown files at `80` characters
@@ -63,7 +63,7 @@ To fix style violations, follow the
 [instruction](https://github.com/DavidAnson/markdownlint#optionsresultversion)
 with the Node version of markdownlint. If you are using Visual Studio Code,
 you can also use the `fixAll` command of the
-[vscode markdownlint extension](hhttps://github.com/DavidAnson/vscode-markdownlint).
+[vscode markdownlint extension](https://github.com/DavidAnson/vscode-markdownlint).
 
 ### Misspell check
 
@@ -81,4 +81,4 @@ To quickly fix typos, use
 
 ```bash
 make misspell-correction
-```
+```

.mdlstyle.rb

@@ -3,12 +3,10 @@ ALL_DOC := $(shell find . -name '*.md' -type f | sort)
 
 TOOLS_DIR := ./.tools
 MISSPELL_BINARY=$(TOOLS_DIR)/misspell
-
-.PHONY: precommit
-precommit: install-misspell misspell
+MARKDOWN_LINK_CHECK=markdown-link-check
 
 .PHONY: install-misspell
-install-misspell: go.mod go.sum internal/tools.go
+install-misspell:
 	go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell
 
 .PHONY: misspell
@@ -18,3 +16,30 @@ misspell:
 .PHONY: misspell-correction
 misspell-correction:
 	$(MISSPELL_BINARY) -w $(ALL_DOCS)
+
+.PHONY: install-markdown-link-check
+install-markdown-link-check:
+	npm install -g $(MARKDOWN_LINK_CHECK)
+
+.PHONY: markdown-link-check
+markdown-link-check:
+	find . -name \*.md -exec $(MARKDOWN_LINK_CHECK) {} \;
+
+.PHONY: enforce-markdown-link-check
+enforce-markdown-link-check:
+	@LINKCHECKOUT=`find . -name \*.md -exec $(MARKDOWN_LINK_CHECK) {} 2>&1 >/dev/null \;`; \
+		if [ "$$LINKCHECKOUT" ]; then \
+			echo "$(MARKDOWN_LINK_CHECK) FAILED => errors:\n"; \
+			echo "Run 'make $(MARKDOWN_LINK_CHECK)' to see the errors" \
+			exit 1; \
+		else \
+			echo "Check markdown links finished successfully"; \
+		fi
+
+.PHONY: install-markdown-lint
+install-markdown-lint:
+	npm install -g markdownlint-cli
+
+.PHONY: markdown-lint
+markdown-lint:
+	markdownlint -c .markdownlint.yaml '**/*.md'

CONTRIBUTING.md

@@ -6,12 +6,12 @@ Table of Contents
 </summary>
 
 - [Overview](#overview)
-    - [CorrelationContext](#correlationcontext)
-    - [Get correlations](#get-correlations)
-    - [Get correlation](#get-correlation)
-    - [Set correlation](#set-correlation)
-    - [Remove correlation](#remove-correlation)
-    - [Clear correlations](#clear-correlations)
+  - [CorrelationContext](#correlationcontext)
+  - [Get correlations](#get-correlations)
+  - [Get correlation](#get-correlation)
+  - [Set correlation](#set-correlation)
+  - [Remove correlation](#remove-correlation)
+  - [Clear correlations](#clear-correlations)
 - [CorrelationContext Propagation](#correlationcontext-propagation)
 - [Conflict Resolution](#conflict-resolution)
 

Makefile

@@ -552,4 +552,4 @@ properties.
 Use Counter instruments to report the number of bytes read and written
 by the storage server.  Configure the SDK to use a Correltion Context
 label key (e.g., named "app.user") to aggregate events by all metric
-instruments.
+instruments.

specification/api-correlationcontext.md

@@ -10,9 +10,9 @@ Table of Contents
 - [Get value](#get-value)
 - [Set value](#set-value)
 - [Optional operations](#optional-operations)
-    - [Get current Context](#get-current-context)
-    - [Attach Context](#attach-context)
-    - [Detach Context](#detach-context)
+  - [Get current Context](#get-current-context)
+  - [Attach Context](#attach-context)
+  - [Detach Context](#detach-context)
 
 </details>
 

specification/api-metrics.md

@@ -21,4 +21,4 @@ attribute names.
 
 Additionally at least one of `net.peer.name` or `net.peer.ip` from the [network attributes][] is required and `net.peer.port` is recommended.
 
-[network attributes]: data-span-general.md#general-network-connection-attributes
+[network attributes]: data-span-general.md#general-network-connection-attributes

specification/context.md

@@ -19,8 +19,8 @@ When associated with a `TracerProvider`,
 all `Span`s produced by any `Tracer` from the provider MUST be associated with this `Resource`.
 
 Analogous to distributed tracing, when used with metrics,
-a resource can be associated with a [MeterProvider](sdk-metrics.md#meter-sdk).
-When associated with a `MeterProvider`,
+a resource can be associated with a `MeterProvider`.
+When associated with a [`MeterProvider`](api-metrics-user.md#obtaining-a-meter),
 all `Metrics` produced by any `Meter` from the provider will be
 associated with this `Resource`.