Skip to content

Commit bd805c0

Browse files
authored
V1.32 release (#536)
* (DOCSP-21428): Added page for Getting Started UI. (#532) * (DOCSP-21428): Added page for Getting Started UI. * (DOCSP-21428): Incorporated Zach's feedback. * (DOCSP-21429): Updated the navigation to the authentication settings. * (DOCSP-21430): Added page for the new Items view. (#534) * (DOCSP-21430): Added page for the new Items view. * (DOCSP-21430): Fixed typo. * (DOCSP-21431): Made changes for the new Data Usage page. (#535) * (DOCSP-21431): Made changes for the new Data Usage page. * (DOCSP-21431): Incorporated Zach's feedback. * (DOCSP-21431): Removed link mention. Added steps.
1 parent 0cf4613 commit bd805c0

21 files changed

+213
-94
lines changed

source/admin-settings.txt

Lines changed: 9 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,25 @@
33
.. _admin-settings:
44
.. _charts-settings:
55

6-
===============
7-
Charts Settings
8-
===============
6+
==========
7+
Data Usage
8+
==========
99

1010
.. default-domain:: mongodb
1111

12-
.. contents:: On this page
13-
:local:
14-
:backlinks: none
15-
:depth: 1
16-
:class: singlecol
12+
The :guilabel:`Data Usage` link appears in the sidebar of the
13+
|charts-short| UI.
1714

18-
The :guilabel:`Charts Settings` link appears in the sidebar of the
19-
Charts UI. All users can access this page. The sections you see depend
20-
on the |service| :atlas:`roles </reference/user-roles/>` you have.
15+
.. include:: /includes/charts-settings-project-owner.rst
2116

2217
.. _admin-usage:
2318

2419
Monthly Data Usage
2520
------------------
2621

27-
.. include:: /includes/charts-settings-project-owner.rst
28-
29-
The :guilabel:`Usage` panel of the :guilabel:`Charts Settings` page shows
30-
the data usage of your |charts| instance over the current month.
22+
The :guilabel:`Data Tranfer by Month` panel of the
23+
:guilabel:`Data Usage` page shows the data usage of your |charts|
24+
instance over the current month.
3125

3226
The panel displays the following metrics:
3327

@@ -56,48 +50,3 @@ MongoDB provides a free ``1 GB`` of data transfers per month. Nearly
5650
all |charts-short| use cases should fall within this ``1 GB`` free
5751
tier. For more information on |charts| pricing and sample pricing
5852
scenarios, see :ref:`charts-billing`.
59-
60-
.. _embedding-auth-providers:
61-
62-
Embedding Authentication Providers
63-
----------------------------------
64-
65-
.. include:: /includes/charts-settings-project-owner.rst
66-
67-
The :guilabel:`Embedding Authentication Providers` panel lists the
68-
providers |charts-short| can use to authenticate users who access
69-
embedded charts.
70-
71-
|charts-short| requires a token from one of the providers you configure
72-
to render authenticated charts embedded with the SDK.
73-
74-
For more information about embedding authentication providers, see
75-
:doc:`/configure-auth-providers`.
76-
77-
Embedding Key Generation
78-
------------------------
79-
80-
.. include:: /includes/charts-settings-project-owner.rst
81-
82-
.. important::
83-
84-
Embedding keys are deprecated and will be removed in a future
85-
release. Use :doc:`Embedding Authentication Providers
86-
</configure-auth-providers>` and the :doc:`Embedding SDK
87-
</embedding-charts-sdk>` instead.
88-
89-
Embedding keys are necessary for generating and verifying digital
90-
signatures of charts embedded using the Verified Signature mode.
91-
92-
To generate a new embedding key, click the :guilabel:`Generate New Key`
93-
button on the right side of the page.
94-
95-
.. warning::
96-
97-
If you generate a new key, any previous keys become invalid. Ensure
98-
that all the existing embedded charts that use the old key are
99-
updated to use the new key.
100-
101-
.. figure:: /images/charts/generate-new-key.png
102-
:figwidth: 650px
103-
:alt: Generate a new embedding key

source/configure-auth-providers.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,28 @@ To delete an embedding authentication provider:
100100

101101
After you delete a provider, all embedded charts that the deleted
102102
provider authenticated no longer render.
103+
104+
Generate an Embedding Key
105+
~~~~~~~~~~~~~~~~~~~~~~~~~
106+
107+
.. include:: /includes/charts-settings-project-owner.rst
108+
109+
.. important::
110+
111+
Embedding keys are deprecated and will be removed in a future
112+
release. Use :ref:`Embedding Authentication Providers
113+
<configure-auth-providers>` and the :doc:`Embedding SDK
114+
</embedding-charts-sdk>` instead.
115+
116+
Embedding keys are necessary for generating and verifying digital
117+
signatures of charts embedded using the :guilabel:`Verified Signature``
118+
mode.
119+
120+
To generate a new embedding key, click the :guilabel:`Generate New Key`
121+
button on the right side of the page.
122+
123+
.. warning::
124+
125+
If you generate a new key, any previous keys become invalid. Ensure
126+
that all the existing embedded charts that use an old key are
127+
updated to use the new key.

source/embed-charts-and-dashboards.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,19 @@ the :ref:`Embedding SDK <embedding-charts-sdk>`, or use static HTML
2222
with a :ref:`charts iframe <embedding-charts-iframe>` or a
2323
:ref:`dashboards iframe <embedding-dashboards-iframe>`.
2424

25+
|charts-short| offers a :guilabel:`Getting Started` UI to help you
26+
learn how to embed charts and dashboards with an iFrame or Javascript
27+
SDK. To learn more, see :ref:`get-started-embedding`.
28+
2529
To learn how to embed charts and dashboards in a web application, see
2630
the :ref:`embedding-tutorials`.
2731

2832
.. toctree::
2933
:titlesonly:
3034

35+
/get-started-embedding
3136
Embed a Chart </embedding-charts>
3237
Embed a Dashboard </embedding-dashboards>
3338
Embedding SDK </embedding-charts-sdk>
39+
/manage-embedded-items
3440
Embedding Error Codes </embedded-chart-error-codes>

source/embedding-charts-iframe.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Embed Charts with an iframe
99
.. contents:: On this page
1010
:local:
1111
:backlinks: none
12-
:depth: 2
12+
:depth: 1
1313
:class: singlecol
1414

1515
You can embed a chart into a web application with an iframe and specify

source/embedding-charts-sdk.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Examples
9797
.. toctree::
9898
:titlesonly:
9999

100-
Getting Started </get-started-embedding-sdk>
100+
/get-started-embedding-sdk
101101
/configure-auth-providers
102102
/handle-click-events
103103
/highlight-chart-elements

source/get-started-embedding.txt

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _get-started-embedding:
2+
3+
==========================
4+
Get Started with Embedding
5+
==========================
6+
7+
.. default-domain:: mongodb
8+
9+
|charts-short| offers a :guilabel:`Getting Started` UI to help you
10+
learn how to embed :ref:`charts <embedding-charts>` and
11+
:ref:`dashboards <embedding-dashboards>` with an iFrame or Javascript
12+
SDK.
13+
14+
Use the Getting Started UI
15+
--------------------------
16+
17+
.. procedure::
18+
:style: normal
19+
20+
.. step:: Go to the :guilabel:`Embedding` page.
21+
22+
Click :guilabel:`Embedding` in the sidebar.
23+
24+
.. step:: Open the :guilabel:`Getting Started` view.
25+
26+
Click the :guilabel:`Getting Started` tab.
27+
28+
.. step:: Configure the :guilabel:`How to embed` section.
29+
30+
a. Click the :guilabel:`Item` that you want to embed.
31+
32+
#. Click the :guilabel:`Method` that you want to use.
33+
34+
.. step:: Review the instructions.
35+
36+
Follow the instructions in the :guilabel:`How to embed`
37+
section to set up embedding in the |charts-short| UI and your
38+
application.
39+
40+
.. step:: Review the embedding features.
41+
42+
Scroll to the the :guilabel:`Embedding features` section to
43+
review the available features and learn more.
44+
45+
.. step:: Review the available resources.
46+
47+
Scroll to the :guilabel:`Resources` section to try different
48+
examples and explore different embedding scenarios.
49+
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.. note::
22

33
Users with any :atlas:`role </reference/user-roles/>` can see this
4-
section on the :guilabel:`Charts Settings` page.
4+
section.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.. note::
22

33
Only users with the :atlas:`Project Owner
4-
</reference/user-roles/#project-roles>` can see this section on the
5-
:guilabel:`Charts Settings` page.
4+
</reference/user-roles/#project-roles>` role can see this section.

source/includes/steps-add-auth-google-tutorial.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ stepnum: 1
33
ref: add-auth-google-charts-nav
44
inherit:
55
file: steps-source-admin-settings.yaml
6-
ref: nav-charts-admin-settings
6+
ref: nav-charts-auth-settings
77
---
88
stepnum: 2
99
ref: add-auth-google-charts-admin

source/includes/steps-add-auth-jwt-tutorial.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ stepnum: 1
33
ref: add-auth-jwt-charts-nav
44
inherit:
55
file: steps-source-admin-settings.yaml
6-
ref: nav-charts-admin-settings
6+
ref: nav-charts-auth-settings
77
---
88
stepnum: 2
99
ref: add-auth-jwt-charts-admin

0 commit comments

Comments
 (0)