Skip to content

Commit 7167772

Browse files
authored
(DOCSP-27745): Charts docs changes - Atlas Charts Activation Optimization (#578)
* Charts Activation Optimization updates * include starter charts step and additional info * tech review * Add project role info
1 parent 5558198 commit 7167772

File tree

6 files changed

+117
-30
lines changed

6 files changed

+117
-30
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ app-services = "App Services"
3030
atlas-app-services = "Atlas App Services"
3131
adf = "Atlas Data Federation"
3232
atlas-app-services-link = ":appservices:`Atlas App Services </>`"
33+
atlas-ui = "Atlas UI"
3334
cluster = "cluster"
3435
clusters = "clusters"
3536
Clusters = "Clusters"

source/build-charts.txt

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ Build Charts
1313
:class: singlecol
1414

1515
Charts provide visual representations of the data in your
16-
:doc:`data source <data-sources>`. A chart maps to a *single*
17-
data source, and can display correlations between several fields in the
18-
data. Charts reside inside :doc:`dashboards </dashboards>`. You must
19-
create a :doc:`dashboard </dashboards>` before you can begin building
16+
:ref:`data source <data-sources>`. A chart maps to a *single*
17+
data source, and it can display correlations between several fields in the
18+
data. Charts reside inside :doc:`dashboards </dashboards>`. Unless
19+
you create a chart :ref:`from the Atlas UI <create-new-chart>`,
20+
you must create a dashboard before you can begin building
2021
charts.
2122

2223
For a complete list of available chart types and how to build specific
@@ -27,7 +28,20 @@ charts, refer to the :ref:`Chart Types <chart-type-reference>` page.
2728
Create a Chart
2829
--------------
2930

30-
.. include:: /includes/steps/build-new-chart.rst
31+
You can create a chart from the :guilabel:`Dashboards` page
32+
in |charts-short| or from the {+atlas-ui+}.
33+
34+
.. tabs::
35+
36+
.. tab:: Charts
37+
:tabid: charts
38+
39+
.. include:: /includes/steps/build-new-chart.rst
40+
41+
.. tab:: {+atlas-ui+}
42+
:tabid: atlas-ui
43+
44+
.. include:: /includes/steps/build-new-chart-atlas.rst
3145

3246
Learn More
3347
----------
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
title: Select a data source in |service|.
2+
ref: new-chart-atlas-data-source.
3+
level: 4
4+
content: |
5+
a. In the left navigation pane in |service|, click :guilabel:`Database`
6+
to display the :guilabel:`Database Deployments` view.
7+
#. Click the :guilabel:`Browse Collections` button for the deployment
8+
that contains the data source.
9+
#. Select the collection that you want to use to build
10+
your chart.
11+
---
12+
title: Click the :guilabel:`Visualize Your Data` button.
13+
ref: new-chart-atlas-visualize-data
14+
level: 4
15+
content: |
16+
|charts-short| automatically loads the data source in the Chart Builder.
17+
18+
.. note::
19+
20+
If you selected a database as your data source, |charts-short| prompts
21+
you to select a specific collection before you can continue building
22+
your chart.
23+
---
24+
title: Apply a suggested chart.
25+
optional: true
26+
ref: apply-starter-chart-atlas
27+
level: 4
28+
inherit:
29+
file: steps-build-new-chart.yaml
30+
ref: apply-starter-chart
31+
---
32+
title: Choose your chart type.
33+
ref: new-chart-type-atlas
34+
level: 4
35+
inherit:
36+
file: steps-build-new-chart.yaml
37+
ref: new-chart-type
38+
---
39+
title: Add fields to your chart.
40+
ref: new-chart-fields-atlas
41+
level: 4
42+
inherit:
43+
file: steps-build-new-chart.yaml
44+
ref: new-chart-fields
45+
46+
---
47+
title: Title your chart.
48+
ref: new-chart-title-atlas
49+
level: 4
50+
inherit:
51+
file: steps-build-new-chart.yaml
52+
ref: new-chart-title
53+
---
54+
title: Save your chart.
55+
ref: new-chart-save-atlas
56+
level: 4
57+
content: |
58+
Once you're satisfied with your chart:
59+
60+
a. Click :guilabel:`Save and close` in the top right corner.
61+
62+
#. Save the chart to a dashboard:
63+
64+
- To save to a new dashboard, click :guilabel:`New` and
65+
specify a :guilabel:`Dashboard title`.
66+
67+
- To save to an existing dashboard, click :guilabel:`Existing`
68+
and select a dashboard from the drop-down menu.
69+
70+
#. Click :guilabel:`Save`. This saves your chart to the specified dashboard and
71+
redirects you to the dashboard view.

source/includes/steps-build-new-chart.yaml

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ content: |
3434
You can click on a data source's name to view a preview of its
3535
data.
3636
37-
.. note::
37+
.. note::
3838
39-
A data source won't display on the :guilabel:`Select Data Source` modal unless it is connected to
40-
|charts-short|. Only a :authrole:`Project Owner` can :ref:`connect
41-
<connect-data-source>` and
42-
:ref:`disconnect <disconnect-data-source>` data sources. All
43-
data sources in the project connect to |charts-short| by default.
39+
A data source won't display on the :guilabel:`Select Data Source` modal unless it is connected to
40+
|charts-short|. Only a :authrole:`Project Owner` can :ref:`connect
41+
<connect-data-source>` and
42+
:ref:`disconnect <disconnect-data-source>` data sources. All
43+
data sources in the project connect to |charts-short| by default.
4444
4545
#. Click :guilabel:`Select` on the data source.
4646
@@ -55,13 +55,12 @@ optional: true
5555
ref: apply-starter-chart
5656
level: 4
5757
content: |
58-
MongoDB Charts displays up to six prebuilt charts based on the data
59-
source that you selected. You can use any one of the suggested charts
60-
to get started by clicking the associated :guilabel:`Apply` button.
58+
In the Chart Builder, |charts-short| displays prebuilt charts based on
59+
the data source that you selected. You can use any one of the suggested
60+
charts to get started by clicking the associated :guilabel:`Apply` button.
6161
After applying a suggested chart, you can make changes to the chart
6262
type and add or remove fields if you wish to customize the prebuilt
6363
chart.
64-
6564
---
6665
title: Choose your chart type.
6766
ref: new-chart-type
@@ -104,14 +103,14 @@ title: Title your chart.
104103
ref: new-chart-title
105104
level: 4
106105
content: |
107-
Give your chart a title by hovering over the
108-
:guilabel:`Enter a title for your chart` text clicking the
109-
:guilabel:`Pencil Icon`. Click the check mark to save your title.
106+
Click the :guilabel:`Enter a title` text and give your
107+
chart a title. To save the title, click the check mark.
110108
---
111109
title: Save your chart.
112110
ref: new-chart-save
113111
level: 4
114112
content: |
115-
Once you are satisfied with your chart, click
116-
:guilabel:`Save Changes`. This saves your chart to your dashboard
113+
Once you're satisfied with your chart, click
114+
:guilabel:`Save and close` in the top right corner.
115+
This saves your chart to your dashboard
117116
and redirects you to the dashboard view.

source/launch-charts.txt

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ Launch MongoDB Charts
1414

1515
The following tutorial guides you through launching |charts-short| on
1616
MongoDB Cloud. You can access |charts-short| with any
17-
:atlas:`Organization Role </reference/user-roles/#organization-roles>`.
17+
:atlas:`Organization Role </reference/user-roles/#organization-roles>`
18+
or any :atlas:`Project Role </reference/user-roles/#project-roles>` that
19+
can read data from |service|.
20+
1821
In |service|, click :guilabel:`Charts` in the navigation bar.
1922

2023
Prerequisites
@@ -33,19 +36,18 @@ You will also need an |service| cluster to visualize data using
3336
.. note::
3437

3538
Each instance of the |charts| application is tied to a single
36-
|service| :atlas:`project </tutorial/manage-projects/>`,
37-
and can only visualize data from |service| clusters within the same
39+
|service| :atlas:`project </tutorial/manage-projects/>`.
40+
You can only visualize data from |service| clusters within the same
3841
project.
3942

4043
Required Access
4144
~~~~~~~~~~~~~~~
4245

4346
This tutorial requires that your :atlas:`Atlas user
44-
</tutorial/manage-users/>` have the appropriate permissions to read
45-
data from the clusters in your |service| project. This means that your
46-
|service| user must have any :atlas:`Project Role
47-
</reference/user-roles/#project-roles>` except ``Project Read Only``,
48-
which does not grant the appropriate permissions.
47+
</tutorial/manage-users/>` have at least
48+
:authrole:`Project Data Access Read Only` permissions. In order to use
49+
|charts-short|, your user must be able to read data from the clusters
50+
in your |service| project.
4951

5052
When you first register an |service| account, you are granted
5153
the ``Project Owner`` role on your initial project. For information
@@ -63,7 +65,7 @@ Moving Forward
6365

6466
Now that you have a data source, you are ready to begin
6567
visualizing your data. The next steps are to
66-
:doc:`create a dashboard </dashboards>`, and then
68+
:doc:`create a dashboard </dashboards>` and
6769
:doc:`build charts </build-charts>` to populate your dashboard.
6870

6971
For complete walkthroughs of |charts| and its features, including

source/tutorial/order-data/create-new-dashboard.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Instructions
1212
Now that you have created your data source, create a dashboard to hold
1313
all of your visualizations:
1414

15-
1. Click :guilabel:`Dashboards` in the sidebar.
15+
1. In |charts|, click :guilabel:`Dashboards` in the sidebar.
1616

1717
#. Click the :guilabel:`New Dashboard` button.
1818

0 commit comments

Comments
 (0)