Add dashboard documentation #134
Conversation
✅ Deploy Preview for suse-obs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| Next to the three dots icon, there is an icon to open the widget in the metric inspector drawer. This allows you to inspect the data of the widget in more detail. | ||
|
|
||
| // TODO STAC-22767 Add screenshot of the dropdown menu? No newline at end of file |
There was a problem hiding this comment.
I would say yes. With the steps getting quite nested, an image would help.
docs/latest/modules/en/pages/use/dashboards/dashboard-organize.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-organize.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-variables.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-widgets.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-widgets.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-widgets.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-widgets.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-widgets.adoc
Outdated
Show resolved
Hide resolved
docs/latest/modules/en/pages/use/dashboards/dashboard-widgets.adoc
Outdated
Show resolved
Hide resolved
akashraj4261
left a comment
akashraj4261
left a comment
There was a problem hiding this comment.
I have suggested a few aesthetic changes as well as sentence structural changes as per SUSE styleguide. Do let me know if you do not agree or find anything not feasible.
Thanks.
….adoc Co-authored-by: akashraj4261 <[email protected]>
Co-authored-by: akashraj4261 <[email protected]>
| * Widget queries, links | ||
| * TODO STAC-22767 - list other places? | ||
|
|
||
| To use a variable in a compatible field, use the variable name preceded by a `$` (for example, `$my_variable`). The value of the variable is interpolated. |
There was a problem hiding this comment.
| To use a variable in a compatible field, use the variable name preceded by a `$` (for example, `$my_variable`). The value of the variable is interpolated. | |
| To use a variable in a compatible field, use the variable name wrapped in a `${}` (for example, `${my_variable}`). The value of the variable is interpolated. |
There was a problem hiding this comment.
I think it would help to also show a screenshot for a widget where a variable like cluster (at least a meaningful variable, ideally the one that is used in the previous screenshot) is used in the Promql query.
| . Open the "Edit dashboard variables" drawer. | ||
| . Click the "Add variable" button to open a second drawer where you can configure the new variable. | ||
|
|
||
| // TODO STAC-22767 Add a screenshot |
There was a problem hiding this comment.
A screenshot that uses a recognizable variable that's already entirely configured would make the most sense I think. For example a cluster variable that uses the cluster_name label. Possibly including a series selector to limit it to something like kubernetes_state_pod_age.
| | Allow multiple values | ||
| | Allow users to select more than one value at a time. | ||
|
|
||
| | Enable "Include Everything" option |
There was a problem hiding this comment.
For both the multiple and the everything option we need to document that it produces a regex during interpolation so it should be used with the Promql regex matcher: =~.
There was a problem hiding this comment.
I've added an additional section that talks about how variables are interpolated
3 participants
No description provided.