Skip to content

Commit 3d94040

Browse files
sfanahataShannon Anahata
andauthored
feat(Dashboards): Added new markdown widget docs (#17163)
Markdown widgets can now be created, and we're documenting that. --------- Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>
1 parent 9709737 commit 3d94040

File tree

4 files changed

+11
-2
lines changed

4 files changed

+11
-2
lines changed

docs/product/dashboards/custom-dashboards/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To restrict who can edit or delete your dashboard, go to the "Edit Access" selec
4444

4545
## Widget Builder
4646

47-
When adding a widget or editing an existing one, you will be presented with a side panel where you can see the dashboard widget builder. The widget builder has several configuration options that you can use to shape data and add information to your dashboard. Learn more in the [Widget Builder documentation](/product/dashboards/widget-builder/).
47+
When adding a widget or editing an existing one, you will be presented with a side panel where you can see the dashboard widget builder. The widget builder has several configuration options that you can use to shape data and add information to your dashboard. Visualization types include [area / bar / line chart](/product/dashboards/widget-builder/#area-chart--bar-time-series--line-chart), [table](/product/dashboards/widget-builder/#table), [big number](/product/dashboards/widget-builder/#big-number), and [markdown](/product/dashboards/widget-builder/#markdown). Learn more about the [Widget Builder](/product/dashboards/widget-builder/).
4848

4949
## Widget Library
5050

250 KB
Loading

docs/product/dashboards/widget-builder/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ In this step, you can choose from the following visualization types:
7373
- [Bar (Categorical)](#bar-categorical)
7474
- [Table](#table)
7575
- [Big Number](#big-number)
76+
- [Markdown](#markdown)
7677

7778
### Area Chart / Bar (Time Series) / Line Chart
7879

@@ -100,6 +101,12 @@ Table charts display the results of a [Discover Query](/product/explore/discover
100101

101102
A big number visualization displays the current value of a single function or [equation](/product/explore/discover-queries/query-builder/query-equations/). This visualization is well suited for high-level aggregates. An example scenario would be “p95 of all transactions”.
102103

104+
### Markdown
105+
106+
Markdown visualizations allow you to display plain text or rich markdown content on your dashboard. This is ideal for providing incident playbooks, or other dashboard-specific instructions. When creating a widget, select a custom widget, and *Text (Markdown)* as the visualization type.
107+
108+
![Markdown widget. =700x](./img/widget-builder-markdown-visualization.png)
109+
103110
## Columns
104111

105112
The option to set columns is only available for [table visualizations](/product/dashboards/widget-builder/#table).

docs/product/dashboards/widget-library/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: >-
77
og_image: /og-images/product-dashboards-widget-library.png
88
---
99

10-
The widget library contains a collection of prebuilt widgets you can add to your [custom dashboards](/product/dashboards/custom-dashboards/). You can access the widget library by clicking the "Add Widget" button and selecting "From Widget Library" on the dashboard.
10+
The widget library contains a collection of prebuilt widgets you can add to your [custom dashboards](/product/dashboards/custom-dashboards/). You can access the widget library by clicking the "Add Widget" button and selecting "From Widget Library" on the dashboard.
11+
12+
You can also create your own custom widgets using the [Widget Builder](/product/dashboards/widget-builder/). This includes all the visualization types you see in the library, plus the ability to add markdown content to your widgets.
1113

1214
The library includes the following widgets:
1315

0 commit comments

Comments
 (0)