diff --git a/.mdox.validator.yaml b/.mdox.validator.yaml index 065e76794..a811f6c1f 100644 --- a/.mdox.validator.yaml +++ b/.mdox.validator.yaml @@ -1,6 +1,13 @@ version: 1 -# Don't check external URLs, they can time-out a lot (rate limits). +explicitLocalValidators: true validators: + # Don't check external URLs for now, they can time-out a lot (rate limits), so they require extra cache setup. - type: ignore - regex: http(s|)://.* \ No newline at end of file + regex: http(s|)://.* + # In docs assets are referenced in links as /assets/..., but the true path is ./public/assets/... + - type: local + regex: "/assets/.*" + anchor: "/public" + - type: local + regex: ".*" \ No newline at end of file diff --git a/Makefile b/Makefile index 083acdf23..c1f01488e 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ MD_FILES_TO_FORMAT=docs/specs/om/open_metrics_spec_2_0.md MDOX="mdox" $(MDOX): - @go install github.com/bwplotka/mdox@v0.9.0 + @go install github.com/bwplotka/mdox@d22b1d641c9b4b7a54c95d279231abe6e5e892fd .PHONY: help help: ## Displays help. @@ -13,7 +13,7 @@ help: ## Displays help. fmt: ## Format docs. fmt: $(MDOX) @echo "Formatting markdown files..." - @$(MDOX) fmt --links.validate $(MD_FILES_TO_FORMAT) + @$(MDOX) fmt --links.validate --links.validate.config-file=./.mdox.validator.yaml $(MD_FILES_TO_FORMAT) .PHONY: check check: ## Checks if doc is formatter and links are correct (don't check external links). diff --git a/docs/specs/om/open_metrics_spec_2_0.md b/docs/specs/om/open_metrics_spec_2_0.md index 04f7afb32..14e93754f 100644 --- a/docs/specs/om/open_metrics_spec_2_0.md +++ b/docs/specs/om/open_metrics_spec_2_0.md @@ -68,6 +68,12 @@ Common examples of metric time series would be network interface counters, devic This section MUST be read together with the ABNF section. In case of disagreements between the two, the ABNF's restrictions MUST take precedence. This reduces repetition as the text wire format MUST be supported. + + +![om2_datamodel.png](/assets/docs/om2_datamodel.png) + ### Data Types #### Values diff --git a/public/assets/docs/om2_datamodel.png b/public/assets/docs/om2_datamodel.png new file mode 100644 index 000000000..114d3161b Binary files /dev/null and b/public/assets/docs/om2_datamodel.png differ