Skip to content

Commit 4dcec3d

Browse files
jwilliams-mongozach-carrjeff-allen-mongosteveren
authored
1.13 release (#340)
* (DOCSP-9286), (DOCSP-9287): As a cloud user, I see the shared Atlas top nav (#325) * (DOCSP-9286): As a cloud user, I see the shared Atlas top nav * (DOCSP-9286): updating one more screenshot * (DOCSP-9286): update image on encoding channels page * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): Basic CRUD for embedded authentication providers (#326) * (embedding-auth): checkpoint * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): Basic CRUD for embedded authentication providers * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): copy review edits * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): tech review feedback * making jwt token validity requirements an include to reuse in tutorial * tech review feedback * (DOCSP-9656) 1.13 - Charts embedding SDK background option (#331) * (DOCSP-9656) Charts embedding SDK background option * (DOCSP-9752): Updates to embed chart procedure for auth providers (#329) * (DOCSP-9752): Updates to embed chart procedure for auth providers * Apply suggestions from code review Co-Authored-By: jwilliams-mongo <[email protected]> * Updates per copy review * Updates per review Co-authored-by: jwilliams-mongo <[email protected]> * (DOCSP-9913): Add embedded auth error codes * (DOCSP-10108): v1.13 Release Notes * Embedding auth (#339) * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): Basic CRUD for embedded authentication providers (#326) * (embedding-auth): checkpoint * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): Basic CRUD for embedded authentication providers * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): copy review edits * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): tech review feedback * making jwt token validity requirements an include to reuse in tutorial * tech review feedback * (DOCSP-9759): Embedding SDK sample for Authenticated: Custom JWT (#328) * (embedding-auth): checkpoint * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): Basic CRUD for embedded authentication providers * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): copy review edits * (DOCSP-9063), (DOCSP-8895), (DOCSP-9763), (DOCSP-9290): tech review feedback * making jwt token validity requirements an include to reuse in tutorial * (DOCSP-9759): Embedding SDK sample for Authenticated: Custom JWT * (DOCSP-9759): fix build warning * (DOCSP-9759): small tweaks * (DOCSP-9759): tech review feedback * (DOCSP-9759): fix warning * (DOCSP-9759): update title * (DOCSP-9759): more tech review feedback * (DOCSP-9759): more tech review feedback * Update steps-embed-chart-sdk-jwt.yaml * DOCSP-9951: [Charts] embedding auth with Stitch (#335) * (DOCSP-9761) Embed a Chart Authenticated with Google Sign-In (#338) * (DOCSP-9761) Google SSO provider tutorial * Updates * Wording * Update from copy review Co-authored-by: jwilliams-mongo <[email protected]> Co-authored-by: Steve Renaker <[email protected]> Co-authored-by: zach-carr <[email protected]> * (DOCSP-9938): Updates for new auto-refresh behavior (#337) * (DOCSP-9938): Updates for new auto-refresh behavior * Updating full screen view image * Updates per copy review * updates based on Tom's feedback Co-authored-by: jwilliams-mongo <[email protected]> * fix conflicts and warnings Co-authored-by: zach-carr <[email protected]> Co-authored-by: jeff-allen-mongo <[email protected]> Co-authored-by: Steve Renaker <[email protected]>
1 parent 8d84cbd commit 4dcec3d

File tree

94 files changed

+1816
-194
lines changed

Some content is hidden

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

94 files changed

+1816
-194
lines changed

conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@
6666
'.. |aws| replace:: :abbr:`AWS (Amazon Web Services)`',
6767
'.. |gcp| replace:: :abbr:`GCP (Google Cloud Platform)`',
6868
'.. |html| replace:: :abbr:`HTML (HyperText Markup Language)`',
69+
'.. |jwt| replace:: :abbr:`JWT (JSON Web Token)`',
70+
'.. |cloud-svc| replace:: :abbr:`Cloud`',
71+
'.. |css| replace:: :abbr:`CSS (Cascading Style Sheets)`',
6972
]
7073

7174
rst_epilog.extend(get_replacements(conf))

config/sphinx_local.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ theme:
2929
- /customize-charts
3030
- /embedding-charts
3131
- /view-export-chart-data
32+
- /embedding-tutorials
33+
3234
sidebars:
3335
'**':
3436
- 'pagenav.html'

source/admin-settings.txt

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ Admin Settings
1111
.. contents:: On this page
1212
:local:
1313
:backlinks: none
14-
:depth: 1
14+
:depth: 2
1515
:class: singlecol
1616

1717
To access the :guilabel:`Admin Settings` page, you must be an |service|
1818
:atlas:`Project Owner </reference/user-roles/#project-roles>`.
1919
If you have the ``Project Owner`` role, the :guilabel:`Admin Settings`
20-
link appears in the top right corner of the Charts UI.
20+
link appears in the sidebar of the Charts UI.
2121

2222
.. _admin-usage:
2323

24-
Usage
25-
-----
24+
Monthly Data Usage
25+
------------------
2626

27-
The :guilabel:`Usage` panel of the :guilabel:`Admin Settings` shows
27+
The :guilabel:`Usage` panel of the :guilabel:`Admin Settings` page shows
2828
the data usage of your |charts| instance over the current month.
2929

3030
The panel displays the following metrics:
@@ -55,12 +55,35 @@ all |charts-short| use cases should fall within this ``1 GB`` free
5555
tier. For more information on |charts| pricing and sample pricing
5656
scenarios, see :ref:`charts-billing`.
5757

58+
.. _embedding-auth-providers:
59+
60+
Embedding Authentication Providers
61+
----------------------------------
62+
63+
The :guilabel:`Embedding Authentication Providers` panel lists the
64+
providers |charts-short| can use to authenticate users who access
65+
embedded charts.
66+
67+
|charts-short| requires a token from one of the providers you configure
68+
to render authenticated charts embedded with the SDK.
69+
70+
For more information about embedding authentication providers, see
71+
:doc:`/configure-auth-providers`.
72+
5873
Embedding Key Generation
5974
------------------------
6075

61-
Embedding keys are necessary for verified signature generation, and are
62-
used in conjunction with :doc:`embedded charts <embedding-charts>`. To
63-
generate a new embedding key, click the :guilabel:`Generate New Key`
76+
.. important::
77+
78+
Embedding keys are deprecated and will be removed in a future
79+
release. Use :doc:`Embedding Authentication Providers
80+
</configure-auth-providers>` and the :doc:`Embedding SDK
81+
</embedding-charts-sdk>` instead.
82+
83+
Embedding keys are necessary for generating and verifying digital
84+
signatures of charts embedded using the Verified Signature mode.
85+
86+
To generate a new embedding key, click the :guilabel:`Generate New Key`
6487
button on the right side of the page.
6588

6689
.. warning::

source/build-charts.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ add a :doc:`data source </data-sources>` and create a :doc:`dashboard
1616
For a complete list of available chart types and how to build specific
1717
charts, refer to the :ref:`Chart Types <chart-type-reference>` page.
1818

19+
.. _create-new-chart:
20+
1921
Create a Chart
2022
--------------
2123

source/configure-auth-providers.txt

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
.. _configure-auth-providers:
2+
3+
============================================
4+
Configure Embedding Authentication Providers
5+
============================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
|charts| uses tokens passed with the Embedding SDK to authenticate users
16+
who want to view authenticated embedded charts. If the details in the
17+
token do not match criteria you specify, if the token is invalid,
18+
or if a token is not present, |charts-short| doesn't render the chart.
19+
20+
Considerations
21+
--------------
22+
- You must be an |service|
23+
:atlas:`Project Owner </reference/user-roles/#project-roles>` to
24+
configure embedding authentication providers for your linked
25+
|charts-short| instance.
26+
27+
- |charts-short| supports these authentication providers:
28+
29+
- :stitch:`Realm </authentication/>`
30+
- Google
31+
- Custom |jwt|
32+
33+
Realm Providers
34+
~~~~~~~~~~~~~~~
35+
36+
|charts-short| considers tokens from Realm providers valid if they:
37+
38+
- Are syntactically valid |jwt|\s.
39+
40+
- Are issued by the relevant authority.
41+
42+
- Match the Realm App ID you configure the provider to accept.
43+
44+
Google Providers
45+
~~~~~~~~~~~~~~~~
46+
47+
|charts-short| considers tokens from Google providers valid if they:
48+
49+
- Are syntactically valid |jwt|\s.
50+
51+
- Are issued by the relevant authority.
52+
53+
- Match the Google Client ID you configure the provider to accept.
54+
55+
JWT Providers
56+
~~~~~~~~~~~~~
57+
58+
.. include:: /includes/jwt-provider-valid-token.rst
59+
60+
Procedures
61+
----------
62+
63+
View Authentication Providers
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65+
66+
To view the embedding authentication providers you have configured:
67+
68+
.. include:: /includes/steps/view-auth-providers.rst
69+
70+
.. _add-auth-provider-steps:
71+
72+
Add an Authentication Provider
73+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74+
75+
To add an embedding authentication provider:
76+
77+
.. include:: /includes/steps/add-auth-providers.rst
78+
79+
Modify an Authentication Provider
80+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81+
82+
To modify an embedding authentication provider:
83+
84+
.. include:: /includes/steps/edit-auth-providers.rst
85+
86+
Delete an Authentication Provider
87+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88+
89+
To delete an embedding authentication provider:
90+
91+
.. include:: /includes/steps/delete-auth-providers.rst
92+
93+
.. important::
94+
95+
After you delete a provider, all embedded charts that the deleted
96+
provider authenticated no longer render.

source/dashboard-permissions.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ To view a chart on a dashboard, the user must have both:
7070
:class: note
7171

7272
You can have no permissions on a dashboard. That dashboard won't
73-
appear on your :ref:`dashboards tab <dashboards-tab>`. Newly-created
73+
appear on your :ref:`dashboards page <dashboards-tab>`. Newly-created
7474
dashboards aren't shared by default. Only the dashboard ``Owner``
7575
can view the dashboard until they grant access to more users.
7676

@@ -120,7 +120,7 @@ Modify Dashboard Permissions
120120

121121
To modify dashboard permissions, either click the click the
122122
:ref:`permission icon <dashboard-permission-icons>` at the top-right of
123-
the dashboard from the :guilabel:`Dashboards` tab:
123+
the dashboard from the :guilabel:`Dashboards` page:
124124

125125
.. figure:: /images/charts/dashboard-permission-icon.png
126126
:figwidth: 750px

source/dashboards.txt

Lines changed: 58 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ attain insight into multiple focal points of your data in a single
1919
display. Dashboards can be shared with other users.
2020

2121
.. _dashboards-tab:
22+
.. _dashboards-page:
2223

23-
Dashboards Tab
24-
--------------
24+
Dashboards Page
25+
---------------
2526

26-
The :guilabel:`Dashboards` tab shows all dashboards you have access to
27+
The :guilabel:`Dashboards` page shows all dashboards you have access to
2728
view. To learn more about dashboard permissions in |charts|, see
2829
:ref:`Dashboard Permissions <dashboard-permissions>`.
2930

@@ -46,12 +47,14 @@ By default, the most recently modified dashboards are shown first in
4647
the list. You can change the sort order by using the
4748
:guilabel:`Sort By` dropdown menu.
4849

50+
.. _create-new-dashboard:
51+
4952
Create a New Dashboard
5053
----------------------
5154

5255
To create a new dashboard:
5356

54-
1. From the :guilabel:`Dashboards` tab, click the
57+
1. From the :guilabel:`Dashboards` page, click the
5558
:guilabel:`New Dashboard` button.
5659

5760
#. In the :guilabel:`New Dashboard` dialog, enter a title for your
@@ -74,62 +77,72 @@ add the first chart to your dashboard:
7477
Refresh Dashboard Data
7578
----------------------
7679

77-
You can refresh dashboard data to update all charts on the dashboard
78-
with the most current data from their respective data sources. When
79-
|charts| loads charts on a dashboard, it does not consistently query
80-
the data source for each chart. Instead, |charts| queries the data
81-
source when the dashboard first loads, and that data
82-
is stored in the browser cache and used to render the charts.
83-
84-
|charts| provides options to both manually refresh dashboard data and
85-
configure the dashboard to automatically refresh at a specified time
86-
interval. These options allow you to control how current the data
87-
displayed on your dashboard is. By default, when you first create a
88-
dashboard, it is configured to refresh its data every hour. The
89-
:guilabel:`Auto` text next to the :icon:`sync-alt` icon signifies that
90-
auto refresh is enabled.
91-
92-
Manually Refresh Dashboard Data
93-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94-
95-
To manually refresh dashboard data, first select a dashboard from the
96-
:guilabel:`Dashboards` tab, then click the :icon:`sync-alt` button at
97-
the top-right of the dashboard.
80+
|charts| automatically refreshes chart data once it becomes out of
81+
date with the backing data source. You can also manually refresh dashboard data at any time.
9882

9983
.. _configure-auto-refresh:
10084

10185
Configure Auto Refresh Settings
10286
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10387

104-
You can configure auto refresh settings to change the interval at which
105-
the dashboard data is refreshed. The dashboard shows the time its data
106-
was last updated and when the next update will occur at the top-right
107-
of the view.
88+
Charts on a dashboard automatically refresh once their data becomes out
89+
of date. You can specify how stale your charts' data can be before it is
90+
refreshed. This is known as your staleness tolerance. The default
91+
behavior is to refresh when data is one hour stale.
10892

109-
To configure auto refresh settings for a dashboard:
93+
To configure auto-refresh settings for a dashboard:
11094

111-
1. From the dashboard view, click the arrow next to the
112-
:icon:`sync-alt` button and click :guilabel:`Auto Refresh Settings`.
95+
1. Select a dashboard from the :guilabel:`Dashboards` page.
11396

114-
#. Select the desired refresh interval.
97+
#. Click :guilabel:`Settings` at the top of the dashboard.
98+
99+
#. Select your data staleness tolerance from the dropdown.
100+
|charts-short| supports staleness tolerances between 1 minute and 30
101+
days.
115102

116103
#. Click :guilabel:`Save`.
117104

118-
.. note::
105+
Behavior
106+
````````
119107

120-
Auto refresh settings are stored in the local browser state.
121-
Settings dictating whether auto refresh is enabled and its
122-
configured interval are not persisted with the dashboard or
123-
shared with other users.
108+
- When |charts-short| refreshes dashboard data, only charts with data
109+
older than your specified staleness tolerance are refreshed.
110+
|charts-short| does not refresh the entire dashboard at once.
124111

125-
Disable and Enable Auto Refresh
112+
- Auto-refresh settings are stored in the local browser state. These
113+
settings are not persisted with the dashboard or shared between
114+
users.
115+
116+
- When |charts| loads charts on a dashboard, it does not consistently
117+
query the data source for each chart. Instead, |charts| queries the
118+
data sources when the dashboard first loads, and that data is cached
119+
on both the client and server.
120+
121+
- When a dashboard refreshes automatically:
122+
123+
- If a chart's data is within the staleness tolerance period,
124+
|charts-short| doesn't refresh the chart's data.
125+
126+
- If a chart's data is outside of the staleness tolerance period,
127+
|charts-short| returns the latest data from the server cache. If the
128+
server cache contains stale data, |charts-short| queries the data
129+
source for the latest data, refreshes the chart, and updates the
130+
data cached on both the client and server.
131+
132+
- When you manually refresh a dashboard, |charts-short| updates all chart
133+
data by querying the data source for the latest data even if the chart
134+
data is within the specified staleness tolerance period.
135+
136+
Manually Refresh Dashboard Data
126137
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127138

128-
To disable auto refresh, click the arrow next to the :icon:`sync-alt`
129-
button and click :guilabel:`Disable Auto Refresh`.
139+
To manually refresh dashboard data:
140+
141+
1. Select a dashboard from the :guilabel:`Dashboards` page.
142+
143+
#. Click the arrow next to the :guilabel:`Settings` button.
130144

131-
To enable auto refresh, click the arrow next to the :icon:`sync-alt`
132-
button and click :guilabel:`Enable Auto Refresh`.
145+
#. Click :guilabel:`Force Refresh`.
133146

134147
.. _fullscreen-view:
135148

@@ -142,7 +155,7 @@ show the title, description, time of last modification, and charts in
142155
the entire space of the screen.
143156

144157
To open a dashboard in fullscreen view, first select a dashboard from
145-
the :guilabel:`Dashboards` tab, then click the expanding arrows at the
158+
the :guilabel:`Dashboards` page, then click the expanding arrows at the
146159
top-right of the dashboard:
147160

148161
.. figure:: /images/charts/full-screen-view.png
@@ -158,8 +171,7 @@ top-right of the dashboard:
158171
over the desired chart.
159172

160173
Additionally, in fullscreen view you can still configure
161-
auto-refresh settings and manually refresh chart data using the
162-
refresh button.
174+
auto-refresh settings and manually refresh chart data.
163175

164176
To exit fullscreen view, either click the contracting arrows at the
165177
top-right of the dashboard or press the escape key.

0 commit comments

Comments
 (0)