Skip to content

Commit 0a9ed82

Browse files
Feature streamlined data sources (#555)
* (DOCSP-22791) Documents streamlined data sources for Charts (#546) * (DOCSP-22791) Documents streamlined data sources for Charts * Test * Fixes list tables * Makes data sources a landing page again * Adds remaining content to connect page * Includes changes from Corry's copy review * Changes small details around charts views on Data Sources page * Includes changes from tech review * (DOCSP-23470) Changes pipelines page to charts views (#549) * DOCSP-24929 updated overflowing tabs (#548) * updated tabs * (DOCSP-23470) Changes pipelines page to charts views * Includes changes from Zach's copy review * Includes changes from tech review Co-authored-by: kyuan-mongodb <[email protected]> * (DOCSP-23603) Updates manage data sources and permissions pages (#551) * (DOCSP-23603) Updates manage data sources page * Removes extra page and finishes manage data sources * Tries adding missing steps file to make staging work * Renames steps file * Comments out a line to fix staging * Includes changes from Zach's copy review * Includes changes from tech review * (DOCSP-21464) Changes to chart builder for streamlined data sources (#553) * (DOCSP-21464) Changes to chart builder for streamlined data sources * Includes changes from copy review, missed line re: searching * Includes changes from tech review * (DOCSP-25141) Misc cleanup and check of all pages for data source changes (#554) * (DOCSP-25141) Misc cleanup and check of all pages for data source changes * Cleanup Co-authored-by: kyuan-mongodb <[email protected]>
1 parent f22b15e commit 0a9ed82

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1062
-769
lines changed

config/redirects

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ raw: docs/charts/filter-documents -> ${base}/filter-chart-results/
2020

2121
# fix stale atlas redirects
2222
raw: docs/charts/atlas ->${base}/
23+
24+
# streamlined data source changes
25+
raw: docs/charts/data-source-pipeline/ ->${base}/create-manage-charts-view
26+
raw: docs/charts/data-source-permissions -> ${base}/manage-data-sources

snooty.toml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ title = "MongoDB Charts"
44
intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv",
55
"https://docs.atlas.mongodb.com/objects.inv"]
66

7-
toc_landing_pages = ["/installation", "/dashboards", "/data-sources",
7+
toc_landing_pages = ["/installation", "/dashboards",
8+
"/data-sources",
9+
"/connect-disconnect-data-source",
810
"/administration", "/build-charts", "/launch-charts",
911
"/tutorial/order-data/order-data-tutorial-overview",
1012
"/tutorial/movie-details/movie-details-tutorial-overview",
@@ -19,6 +21,7 @@ toc_landing_pages = ["/installation", "/dashboards", "/data-sources",
1921
"/view-export-chart-data",
2022
"/embedding-tutorials",
2123
"/embedding-charts-sdk",
24+
"/manage-data-sources",
2225
"/bin-data", "/encoding-channels"]
2326

2427
[constants]
@@ -27,8 +30,17 @@ app-services = "App Services"
2730
atlas-app-services = "Atlas App Services"
2831
adf = "Atlas Data Federation"
2932
atlas-app-services-link = ":appservices:`Atlas App Services </>`"
33+
cluster = "cluster"
34+
clusters = "clusters"
35+
Clusters = "Clusters"
36+
database-deployment = "database deployment"
3037
fdi = "federated database instance"
3138
fdis = "federated database instances"
39+
Fdis = "Federated database instances"
40+
serverless-instance = "serverless instance"
41+
serverless-instances = "serverless instances"
42+
Serverless-instances = "Serverless-instances"
43+
Serverless-Instances = "Serverless Instances"
3244

3345
[substitutions]
3446
charts = "MongoDB Charts"

source/aggregation-pipeline-generation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ option in the Chart Builder's ellipsis dropdown on the top right.
1818

1919
The pipeline constructed by |charts| consists of the following segments in the following order:
2020

21-
1. :ref:`Data source pipelines <data-sources-pipeline>`
21+
1. :ref:`Charts views <data-sources-pipeline>`
2222
#. :ref:`Dashboard filters <filter-dashboards>`
2323
#. :ref:`Chart query <query-bar>`
2424
#. :ref:`Embedding filters <embedded-chart-options>`

source/build-charts.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ Build Charts
1515
Charts provide visual representations of the data in your
1616
:doc:`data source <data-sources>`. A chart maps to a *single*
1717
data source, and can display correlations between several fields in the
18-
data. Charts reside inside :doc:`dashboards </dashboards>`. You must
19-
add a :doc:`data source </data-sources>` and create a :doc:`dashboard
20-
</dashboards>` before you can begin building charts.
18+
data. Charts reside inside :doc:`dashboards </dashboards>`. You must create a :doc:`dashboard </dashboards>` before you can begin building charts.
2119

2220
For a complete list of available chart types and how to build specific
2321
charts, refer to the :ref:`Chart Types <chart-type-reference>` page.

source/chart-type-reference/geospatial-scatter.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,16 +140,15 @@ Build a Geospatial Scatter Chart
140140

141141
To create a geospatial scatter chart:
142142

143-
1. On the :guilabel:`Chart Builder`, select :guilabel:`Geospatial` from
143+
1. On the :guilabel:`Chart Builder`, choose the data source for your
144+
chart.
145+
146+
#. Select :guilabel:`Geospatial` from
144147
the :guilabel:`Chart Type` list.
145148

146149
#. Select :guilabel:`Scatter` from the three available geospatial
147150
chart types.
148151

149-
#. Choose the data source for your chart from the :guilabel:`Data Source` list.
150-
151-
.. note:: See :ref:`Add a Data Source <add-data-source>` if you have not yet defined a data source for your charts.
152-
153152
#. Drag a geopoint field from :guilabel:`Fields` to the :guilabel:`Coordinates`
154153
encoding channel.
155154

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
2+
.. _data-sources-view:
3+
.. _connect-disconnect-data-source:
4+
5+
==================================================
6+
Connect or Disconnect Data Sources and Deployments
7+
==================================================
8+
9+
.. default-domain:: mongodb
10+
11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 1
15+
:class: singlecol
16+
17+
On the :guilabel:`Data Sources` page, an |service|
18+
:authrole:`Project Owner` can:
19+
20+
- :ref:`Connect a deployment <connect-deployment>` or
21+
:ref:`connect a data source <connect-data-source>` to |charts|.
22+
- :ref:`Disconnect a deployment <disconnect-deployment>` or
23+
:ref:`disconnect a data source <disconnect-data-source>` from
24+
|charts|.
25+
26+
To learn more about data sources and deployments, see :ref:`data-sources`.
27+
28+
|charts-short| connects to all deployments and data sources by default.
29+
30+
.. _connect-deployment:
31+
32+
Connect a Deployment to |charts-short|
33+
--------------------------------------
34+
35+
You can connect a deployment to |charts-short| to access the
36+
data for the collections within the deployment in |charts-short|.
37+
38+
To connect a deployment to |charts-short|:
39+
40+
.. procedure::
41+
:style: normal
42+
43+
.. include:: /includes/steps-access-deployment.rst
44+
45+
.. include:: /includes/steps-connect-deployment.rst
46+
47+
To learn more about the other information that displays for the
48+
deployment, see :ref:`manage-deployment`.
49+
50+
.. _add-data-source:
51+
.. _connect-data-source:
52+
53+
Connect a Data Source to |charts-short|
54+
---------------------------------------
55+
56+
Connect a data source to |charts-short| to use its data in your charts.
57+
58+
When you connect a data source, |charts-short| grants the default
59+
:ref:`permissions <permission-model>` to |charts-short| users. To
60+
customize the permissions for a data source, see
61+
:ref:`mod-data-source-permissions`.
62+
63+
To connect a data source to |charts-short|:
64+
65+
.. procedure::
66+
:style: normal
67+
68+
.. step:: Connect your deployment.
69+
70+
To learn more, see :ref:`connect-deployment`.
71+
72+
.. step:: In the :guilabel:`Data Access` section, select the database that contains the data source.
73+
74+
Select the database that contains the data source you want to
75+
connect. The database's data sources display, including
76+
:ref:`charts views <charts-views>`.
77+
78+
|charts-short| displays the following information about the data source:
79+
80+
.. list-table::
81+
:header-rows: 1
82+
:widths: 38 72
83+
84+
* - Column
85+
- Description
86+
87+
* - :guilabel:`Data Source`
88+
- Human-readable label that identifies the data source and
89+
its chart views.
90+
91+
* - :guilabel:`External Users`
92+
- Label that indicates whether:
93+
94+
- You enabled external user access.
95+
- The external user connection method is
96+
:guilabel:`Authenticated` or :guilabel:`Unauthenticated`.
97+
98+
* - :guilabel:`Status`
99+
- Label that indicates whether you connected the
100+
data source to |charts|.
101+
102+
.. step:: Click :guilabel:`Manage` next to the data source's information.
103+
104+
The data source's details page displays the following
105+
information:
106+
107+
.. list-table::
108+
:header-rows: 1
109+
:widths: 38 72
110+
111+
* - Field
112+
- Description
113+
114+
* - :guilabel:`Data Source Name`
115+
- Human-readable label that identifies the data source in
116+
|service|.
117+
118+
* - :guilabel:`Data Source Connection Status`
119+
- Label that indicates whether you connected the
120+
data source to |charts|.
121+
122+
To learn more about the other information that displays on the
123+
data source's details page, see
124+
:ref:`manage-existing-data-sources`.
125+
126+
.. step:: Check the connection status and connect the data source.
127+
128+
If the data source connection status is :guilabel:`Connected`,
129+
you already connected this data source to |charts|. The
130+
:guilabel:`Data Access` section displays.
131+
132+
If the data source connection status is :guilabel:`Disconnected`:
133+
134+
a. Click the connect icon :icon-fa5:`link` next to the data
135+
source connection status.
136+
#. Click :guilabel:`Reconnect` on the modal that displays.
137+
138+
The data source connects and the :guilabel:`Data Access`
139+
section displays.
140+
141+
To learn more about the other information that displays in the
142+
data source's :guilabel:`Data Access` section, see
143+
:ref:`manage-existing-data-sources`.
144+
145+
.. _disconnect-deployment:
146+
147+
Disconnect a Deployment from |charts-short|
148+
-------------------------------------------
149+
150+
Disconnect a deployment to disconnect all data sources within the
151+
deployment from |charts-short|.
152+
153+
If you disconnect a deployment, you can :ref:`reconnect
154+
<connect-deployment>` it later to resume rendering charts that use the
155+
deployment's data sources.
156+
157+
To disconnect a deployment:
158+
159+
.. procedure::
160+
:style: normal
161+
162+
.. include:: /includes/steps-access-deployment.rst
163+
164+
.. step:: Check the connection status and disconnect the deployment.
165+
166+
If the deployment connection status is :guilabel:`Disconnected`,
167+
the deployment is already disconnected from |charts-short|.
168+
169+
If the deployment connection status is :guilabel:`Connected`:
170+
171+
a. Click the disconnect icon :icon-fa5:`unlink` next to the deployment connection
172+
status. The :guilabel:`Disconnect Deployment` modal appears.
173+
#. Click :guilabel:`Check for connected charts` to
174+
learn whether any charts use the deployment's collections as a
175+
data source.
176+
#. Click :guilabel:`Disconnect`.
177+
178+
The deployment disconnects from |charts-short|.
179+
180+
.. _disconnect-data-source:
181+
182+
Disconnect a Data Source from |charts|
183+
--------------------------------------
184+
185+
Disconnect a data source from |charts-short| to remove its data from
186+
your charts. If you disconnect a data source:
187+
188+
- Any charts you built that use the data source no longer
189+
render and display an error.
190+
- Any charts that use :pipeline:`$lookup` to access data in the data
191+
source no longer render and display an error.
192+
- You can't use the data source to build new charts.
193+
194+
You can also :ref:`disconnect a deployment <disconnect-deployment>`.
195+
196+
If you disconnect a data source, you can :ref:`reconnect
197+
<connect-data-source>` it later to resume rendering charts that
198+
use its data.
199+
200+
.. note::
201+
202+
.. include:: /includes/sample-data-source-description.rst
203+
204+
To disconnect a data source from |charts-short|:
205+
206+
.. procedure::
207+
:style: normal
208+
209+
.. include:: /includes/steps-access-deployment.rst
210+
211+
.. step:: In the :guilabel:`Data Access` section, select the database that contains the data source.
212+
213+
Select the database that contains the data source you want to
214+
disconnect. The database's data sources display.
215+
216+
.. step:: Click :guilabel:`Manage` next to the data source's information.
217+
218+
The data source's details page displays.
219+
220+
.. step:: Check the connection status and disconnect the data source.
221+
222+
If the data source connection status is :guilabel:`Disconnected`,
223+
the data source is already disconnected from |charts|.
224+
225+
If the data source connection status is :guilabel:`Connected`:
226+
227+
a. Click the disconnect icon :icon-fa5:`unlink` next to the data
228+
source connection
229+
status. The :guilabel:`Disconnect Data Source` modal appears.
230+
#. Click :guilabel:`Check for connected charts` to
231+
learn whether any charts use the
232+
data source.
233+
#. Click :guilabel:`Disconnect`.
234+
235+
The data source disconnects from |charts-short|.

0 commit comments

Comments
 (0)