Skip to content

Commit ce7f9bf

Browse files
authored
docs: fix metrics page admonitions and other tidying (#13632)
Signed-off-by: Alan Clucas <[email protected]>
1 parent a7205b2 commit ce7f9bf

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/metrics.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Prometheus Metrics
1+
# Metrics
22

33
> v2.7 and after
44
5-
!!! Metrics changes in 3.6
5+
!!! Warning "Metrics changes in 3.6"
66
Please read [this short guide](upgrading.md#metrics-changes) on what you must consider when upgrading to 3.6.
77

88
## Introduction
@@ -197,10 +197,12 @@ Metrics for the [Four Golden Signals](https://sre.google/sre-book/monitoring-dis
197197
- Errors: `count` and `error_count`
198198
- Saturation: `workers_busy` and `workflow_condition`
199199

200-
!!! High cardinality
200+
!!! Warning "High cardinality"
201201
Some metric attributes may have high cardinality and are marked with ⚠️ to warn you. You may need to disable this metric or disable the attribute.
202+
202203
<!-- titles should be the exact metric name for deep-linking, alphabetical ordered -->
203204
<!-- titles are without argo_workflows prefix -->
205+
204206
#### `cronworkflows_concurrencypolicy_triggered`
205207

206208
A counter of the number of times a CronWorkflow has triggered its `concurrencyPolicy` to limit the number of workflows running.

docs/workflow-creator.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ metadata:
1111
name: my-wf
1212
labels:
1313
workflows.argoproj.io/creator: admin
14-
# labels must be DNS formatted, so the "@" is replaces by '.at.'
14+
# labels must be DNS formatted, so the "@" is replaces by '.at.'
1515
workflows.argoproj.io/creator-email: admin.at.your.org
1616
workflows.argoproj.io/creator-preferred-username: admin-preferred-username
1717
```
1818
19-
!!! NOTE
19+
!!! Note
2020
Labels only contain `[-_.0-9a-zA-Z]`, so any other characters will be turned into `-`.

0 commit comments

Comments
 (0)