Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .mdox.validator.yaml
Original file line number Diff line number Diff line change
@@ -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|)://.*
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: ".*"
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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).
Expand Down
6 changes: 6 additions & 0 deletions docs/specs/om/open_metrics_spec_2_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!---
# Diagram source: https://docs.google.com/presentation/d/1ovDkQVm84zo5ktWZVm5XosLS2YMRgdSJCevVivAlLW0/edit?slide=id.g3cfc897512e_0_291#slide=id.g3cfc897512e_0_291
-->

![om2_datamodel.png](/assets/docs/om2_datamodel.png)

### Data Types

#### Values
Expand Down
Binary file added public/assets/docs/om2_datamodel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading