Skip to content

Commit 98e65dc

Browse files
authored
(DOCSP-32375) Update Dashboard landing (+ update Create a New Dashboard and Export a Dashboard procedures). (#615)
* (DOCSP-32375) edited Dashboards procedure. * (DOCSP-32375) Formatting procedure. * (DOCSP-32375) Formatting procedure. * (DOCSP-32375) Formatting procedure. * (DOCSP-32375) Added directions to reach Dashboards Page. * (DOCSP-32375) Replaced Dashboard landing screenshot * (DOCSP-32375) Edits. * (DOCSP-32375) Edits. * (DOCSP-32375) Edits. * (DOCSP-32375) Edits. * (DOCSP-32375) Formatted step * (DOCSP-32375) Export dashboard procedure. * (DOCSP-32375) Export dashboard procedure. * (DOCSP-32375) Export dashboard procedure. * (DOCSP-32375) Export dashboard procedure. * (DOCSP-32375) Export dashboard procedure. * (DOCSP-32375) Bullet list format. * (DOCSP-32375) Bullet list format. * (DOCSP-32375) Bullet list format. * (DOCSP-32375) Bullet list format. * (DOCSP-32375) Edited export charts (DOCSP-31734). * (DOCSP-32375) Procedure formatting. * (DOCSP-32375) Internal review edits. * (DOCSP-32375) Internal review edits. * (DOCSP-32375) Internal review edits.
1 parent c406fd2 commit 98e65dc

File tree

3 files changed

+130
-102
lines changed

3 files changed

+130
-102
lines changed

source/dashboards.txt

Lines changed: 129 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ display. Dashboards can be shared with other users.
2424
Dashboards Page
2525
---------------
2626

27-
The :guilabel:`Dashboards` page shows all dashboards you have access to
28-
view. To learn more about dashboard permissions in |charts|, see
29-
:ref:`Dashboard Permissions <dashboard-permissions>`.
27+
The :guilabel:`Dashboards` page shows all dashboards you have access to view.
28+
To get to your project's :guilabel:`Dashboards` page, click :guilabel:`Charts` in the |service| navigation bar.
29+
30+
To learn more about dashboard permissions in |charts|, see :ref:`Dashboard Permissions <dashboard-permissions>`.
3031

3132
.. figure:: /images/charts/charts-dashboard-landing.png
3233
:figwidth: 750px
@@ -52,25 +53,26 @@ the list. You can change the sort order by using the
5253
Create a New Dashboard
5354
----------------------
5455

55-
To create a new dashboard:
56-
57-
1. From the :guilabel:`Dashboards` page, click the
58-
:guilabel:`Add Dashboard` button.
56+
To create a new dashboard:
5957

60-
#. In the :guilabel:`Add Dashboard` dialog, enter a title for your
61-
dashboard.
58+
.. procedure:: Create a New Dashboard
59+
:style: normal
6260

63-
#. (Optional) Enter a :guilabel:`description` for your dashboard.
61+
.. step:: From the :guilabel:`Dashboards` page,
62+
click :guilabel:`Add Dashboard`.
6463

65-
#. Click :guilabel:`Create`.
64+
.. step:: In the :guilabel:`Add Dashboard` dialog,
65+
enter a :guilabel:`Title` for your dashboard. Optionally, enter a :guilabel:`Description`.
6666

67-
After after clicking the :guilabel:`Create` button you are taken
68-
to the page for your newly created dashboard, where you are prompted to
69-
add the first chart to your dashboard:
70-
71-
.. figure:: /images/charts/charts-dashboard-new.png
72-
:figwidth: 750px
73-
:alt: Charts New Dashboard Example
67+
.. step:: Click
68+
:guilabel:`Save`.
69+
70+
|charts-short| opens your newly created dashboard and prompts you
71+
to add the first chart to your dashboard:
72+
73+
.. figure:: /images/charts/charts-dashboard-new.png
74+
:figwidth: 750px
75+
:alt: Charts New Dashboard Example
7476

7577
.. _sample-dashboard:
7678
.. _add-sample-dashboard:
@@ -88,32 +90,33 @@ examples of charts you can create.
8890
sample dashboard in your |charts-short| project. This can be useful
8991
if you have changed a sample dashboard and want a fresh copy.
9092

91-
To create a sample dashboard:
93+
To add a sample dashboard:
9294

93-
1. From the :guilabel:`Dashboards` page, expand the
94-
:guilabel:`Add Dashboard` dropdown menu.
95+
.. procedure:: Create a Sample Dashboard
96+
:style: normal
9597

96-
#. Select :guilabel:`Add sample dashboard`.
98+
.. step:: From the :guilabel:`Dashboards` page,
99+
expand the :guilabel:`Add Dashboard` dropdown menu and select :guilabel:`Add sample dashboard`.
97100

98-
#. Select a category of sample data with which to create a sample
99-
dashboard. You can choose from the following sample dashboards.
100-
101-
.. note::
102-
103-
Each of the following links provides a public preview version of
104-
a sample dashboard where you can experiment with
105-
:ref:`dashboard filtering <dashboard-filtering>`
106-
and :ref:`interactive filtering <interact-with-charts>`.
101+
.. step:: In the :guilabel:`Add sample dashboard` modal,
102+
select a category of sample data with which to create a sample dashboard.
103+
You can choose from the following sample dashboards:
107104

108-
- `Product event metadata <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f973-045a-4862-83f4-514e7d2df8fc?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
109-
- `Sales records <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6139c-742a-4572-8921-a318dfb26bd6?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
110-
- `System metrics for observability <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f9a1-40f8-460f-862f-c5f0a8ab45ad?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
111-
- |iot| `time series data <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f9ce-742a-4509-8d36-a318df9c1fe2?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
112-
- `Movie data <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f9df-b820-471a-87f3-6390d7e0dc74?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
105+
- `Product event metadata <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f973-045a-4862-83f4-514e7d2df8fc?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
106+
- `Sales records <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6139c-742a-4572-8921-a318dfb26bd6?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
107+
- `System metrics for observability <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f9a1-40f8-460f-862f-c5f0a8ab45ad?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
108+
- |iot| `time series data <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f9ce-742a-4509-8d36-a318df9c1fe2?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
109+
- `Movie data <https://charts.mongodb.com/charts-embedding-examples-wgffp/public/dashboards/63f6f9df-b820-471a-87f3-6390d7e0dc74?ajs_event=Link%20from%20Charts%20docs&ajs_prop_referrer=https://www.mongodb.com/docs/charts/>`__
113110

114-
After you select a category of sample data, |charts-short|
115-
creates a new :guilabel:`Sample Dashboard` of which you are the
116-
``Owner``.
111+
.. note::
112+
113+
Each of the above links provides a public preview version of
114+
a sample dashboard where you can experiment with
115+
:ref:`dashboard filtering <dashboard-filtering>`
116+
and :ref:`interactive filtering <interact-with-charts>`.
117+
118+
.. step:: Click :guilabel:`Add and Open`
119+
to create a new :guilabel:`Sample Dashboard` of which you are the ``Owner``.
117120

118121
You can also create a :guilabel:`Sample Dashboard` by going through
119122
the |charts-short| :ref:`Welcome Experience <welcome-experience>`.
@@ -169,7 +172,23 @@ Export a Dashboard to a File
169172
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
170173

171174
You can export a dashboard to a single file named
172-
``<Dashboard-Title>.charts``. The file contains the metadata for the
175+
``<Dashboard-Title>.charts``.
176+
You can export a dashboard from the :guilabel:`Dashboards` page or from
177+
the dashboard itself.
178+
179+
To export a dashboard:
180+
181+
.. procedure::
182+
:style: normal
183+
184+
.. step:: If you are on the :guilabel:`Dashboards` page, click the ellipsis
185+
(``...``) for the dashboard you want to export. If you are already viewing a specific dashboard, click the ellipsis
186+
(``...``) in the top right corner.
187+
188+
.. step:: Click
189+
:guilabel:`Export as .charts`.
190+
191+
The ``<Dashboard-Title>.charts`` file contains the metadata for the
173192
dashboard, including:
174193

175194
- Dashboard name and description
@@ -188,7 +207,7 @@ dashboard, including:
188207
- Filter allow list
189208
- Injected filter code
190209

191-
The file **doesn't** include:
210+
The ``<Dashboard-Title>.charts`` file does **not** include:
192211

193212
- Dashboard :ref:`permissions <dashboard-permissions>`
194213
- External sharing settings for the data sources used
@@ -198,91 +217,96 @@ The file **doesn't** include:
198217
You must have ``Viewer`` or higher :ref:`permissions
199218
<dashboard-permissions>` to export a dashboard.
200219

201-
You can export a dashboard from the :guilabel:`Dashboards` page or from
202-
the dashboard itself. To export a dashboard:
203220

204-
1. If you are on the :guilabel:`Dashboards` page, click the ellipsis
205-
(``...``) for the dashboard you want to export.
206221

207-
If you are on a dashboard, click the ellipsis
208-
(``...``) in the top right corner.
209222

210-
#. Follow the browser prompts to download the file.
211223

212224
.. _import-dashboard:
213225

214226
Import a Dashboard From a File
215227
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
216228

217229
You can import a dashboard from a file on the :ref:`Dashboards page
218-
<dashboards-tab>`. The file to import:
230+
<dashboards-tab>`.
231+
232+
The file to import:
219233

220234
- Can't be larger than 16 MBs
221235
- Must be a valid ``.charts`` file that you downloaded from a
222236
dashboard
223237

224-
From the :guilabel:`Dashboards` page:
225-
226-
1. Click the :guilabel:`Add Dashboard` dropdown and select
227-
:guilabel:`Import Dashboard` to display the :guilabel:`Import
228-
Dashboard` modal.
238+
To import a dashboard from a file:
229239

230-
#. Drag and drop the file to import or click :guilabel:`Choose File`
231-
and select the file to import.
240+
.. procedure:: Import a Dashboard From a File
241+
:style: normal
232242

233-
#. Click :guilabel:`Next`.
243+
.. step:: From the :guilabel:`Dashboards` page,
244+
expand the :guilabel:`Add Dashboard` dropdown menu and select :guilabel:`Import Dashboard`.
234245

235-
#. Click the pencil icon :icon-fa4:`pencil` under
236-
:guilabel:`Data source at destination`.
246+
.. step:: In the :guilabel:`Import Dashboard` modal, drag and drop the file to import
247+
or click :guilabel:`Choose File` and select the file to import.
237248

238-
#. Select the data source for the dashboard.
239-
240-
The :guilabel:`Import Dashboard` modal displays a list of all the
241-
data sources used by the file being imported under :guilabel:`Data
242-
source in file` column. For each data source in the file, select a
243-
:guilabel:`Data source at destination`:
249+
.. step:: Click
250+
:guilabel:`Next`.
244251

245-
.. list-table::
246-
:header-rows: 1
247-
:widths: 20 40
252+
.. step:: Click the pencil icon :icon-fa4:`pencil`
253+
under :guilabel:`Data source at destination`.
248254

249-
* - Option
250-
- Description
255+
.. step:: Select the :guilabel:`Data source at destination`
256+
for each :guilabel:`Data source in file`.
251257

252-
* - :guilabel:`Connect later`
253-
- Option to choose the data source to use later. |charts|
254-
imports all charts using the :guilabel:`Data source in file`,
255-
but no data source is selected. The charts don't render until
256-
you edit each chart and choose a new data source.
257-
258-
* - :guilabel:`Connect now`
259-
- Option to select any data source in your project. The data
260-
source you select is used instead of the :guilabel:`Data
261-
source in file` for charts imported in to the dashboard.
262-
263-
To select a data source, select a deployment from the first dropdown, then select a database and a data source.
264-
265-
* - :guilabel:`Exclude charts using this data source`
266-
- Option to exclude charts that use the :guilabel:`Data source
267-
in file`. Charts that use the :guilabel:`Data source in
268-
file` won't be imported.
269-
270-
If |charts| detects that a data source in your project is the same
271-
as the data source in the file, that data source is selected by
272-
default. Otherwise, :guilabel:`Connect later` is selected by default.
258+
The :guilabel:`Import Dashboard` modal displays a list of all of the data
259+
sources you are importing under the :guilabel:`Data source in file` column.
260+
To connect each data source from your imported dashboard to a data source in your destination project,
261+
choose one of the following options under the :guilabel:`Data Source at Destination` column:
262+
263+
.. list-table::
264+
:header-rows: 1
265+
:widths: 15 40
266+
267+
* - Option
268+
- Description
269+
270+
* - :guilabel:`Connect later`
271+
- Option to choose the data source to use later. |charts|
272+
imports all charts using the :guilabel:`Data source in file`,
273+
but no data source is selected. The charts don't render until
274+
you edit each chart and choose a new data source.
275+
276+
* - :guilabel:`Connect now`
277+
- Option to select any data source in your project. The data
278+
source you select is used instead of the :guilabel:`Data
279+
source in file` for charts imported in to the dashboard.
280+
281+
If |charts| detects that a data source in your imported dashboard is the same
282+
as the data source in your destination project, that data source is selected by
283+
default. Otherwise, :guilabel:`Connect later` is selected by default.
284+
285+
To select a data source:
286+
287+
1. Select a deployment from the first dropdown.
288+
#. Select a database from the second dropdown.
289+
#. Select a data source from the third dropdown.
290+
#. Click :guilabel:`Save`.
291+
292+
* - :guilabel:`Exclude charts using this data source`
293+
- Option to exclude charts that use the :guilabel:`Data source
294+
in file`. Charts that use the :guilabel:`Data source in
295+
file` won't be imported.
273296

274297
.. important::
275298

276299
Imported charts may not render properly if mapped to a data
277300
source that the chart wasn't built to use.
278301

279-
#. Click one of these buttons:
302+
.. step:: Click one of the
303+
following buttons:
280304

281-
- :guilabel:`Save` to import the dashboard.
282-
- :guilabel:`Save and Import Another` to import this dashboard and
283-
import another dashboard from a file.
284-
- :guilabel:`Cancel` to exit the modal without importing the
285-
dashboard.
305+
- :guilabel:`Save` to import the dashboard.
306+
- :guilabel:`Save and Import Another` to import this dashboard and
307+
import another dashboard from a file.
308+
- :guilabel:`Cancel` to exit the modal without importing the
309+
dashboard.
286310

287311
.. _fullscreen-view:
288312

@@ -296,10 +320,14 @@ the entire space of the screen.
296320

297321
To enter the fullscreen view for dashboards:
298322

299-
1. Select a dashboard from the :guilabel:`Dashboards` page.
323+
.. procedure:: Import a Dashboard From a File
324+
:style: normal
300325

301-
#. Click the :guilabel:`View full screen` (:icon-fa5:`expand`) icon at
302-
the top-right of the dashboard.
326+
.. step:: Select a dashboard from the
327+
:guilabel:`Dashboards` page.
328+
329+
.. step:: Click
330+
:icon-fa5:`expand` at the top-right of the dashboard.
303331

304332
.. note::
305333

@@ -317,7 +345,7 @@ To enter the fullscreen view for dashboards:
317345
To exit the fullscreen view for dashboards, do one of the following
318346
tasks:
319347

320-
- Click the :guilabel:`Exit full screen` (:icon-fa5:`compress`) icon at
348+
- Click :icon-fa5:`compress` at
321349
the top-right of the dashboard.
322350

323351
- Press the escape key.
Loading

source/includes/create-dashboard-steps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ visualizations:
99

1010
1. Click the :guilabel:`Dashboards` tab.
1111

12-
#. Click the :guilabel:`New Dashboard` button.
12+
#. Click the :guilabel:`Add Dashboard` button.
1313

1414
#. Copy the following into the :guilabel:`Title` input:
1515

0 commit comments

Comments
 (0)