Skip to content

Commit 043233e

Browse files
authored
(DOCSP-39599): Adds include for nav to Charts. (#655)
* (DOCSP-39599): Adds include for nav to Charts. * (DOCSP-39599): Incorporated David's feedback.
1 parent 051a4a0 commit 043233e

13 files changed

+263
-371
lines changed

source/dashboards.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,14 @@ Dashboards Page
2525
---------------
2626

2727
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.
28+
To get to your project's :guilabel:`Dashboards` page:
29+
30+
.. procedure::
31+
:style: normal
32+
33+
.. include:: /includes/nav/steps-charts.rst
34+
35+
.. step:: Click :guilabel:`Project`.
2936

3037
To learn more about dashboard permissions in |charts|, see :ref:`Dashboard Permissions <dashboard-permissions>`.
3138

source/dashboards/dashboard-access/dashboard-ownership.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To view the owners of any dashboard in your project:
3131
.. procedure::
3232
:style: normal
3333

34-
.. step:: Click :guilabel:`Charts` in the navigation bar to navigate to |charts|.
34+
.. include:: /includes/nav/steps-charts.rst
3535

3636
.. step:: Click :guilabel:`Owners` under :guilabel:`Dashboards` in the sidebar.
3737

source/embedding-charts-iframe.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Procedure
5959
:guilabel:`Authenticated Embedding` tab for
6060
instructions on securing your charts.
6161

62-
.. include:: /includes/steps/enable-embedding-iframe-verified.rst
62+
.. include:: /includes/steps-enable-embedding-iframe-verified.rst
6363

6464
After your iframe code is ready with any options you've set, you can place
6565
it in a web page to display your chart.

source/includes/nav/steps-charts.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. step:: Go to :guilabel:`Charts`.
2+
3+
If |charts| is not already displayed, click
4+
the :guilabel:`Charts` tab in the |service| UI.
5+
6+
|service| launches an instance of |charts-short| linked to your
7+
project.

source/includes/steps-add-data-source-mflix.yaml

Lines changed: 0 additions & 50 deletions
This file was deleted.

source/includes/steps-add-data-source-supplies.yaml

Lines changed: 0 additions & 50 deletions
This file was deleted.
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
.. procedure::
2+
:style: normal
3+
4+
.. include:: /includes/nav/steps-charts.rst
5+
6+
.. step:: Select a dashboard.
7+
8+
From your dashboard page, select the dashboard containing the
9+
chart for which you want to enable embeddings.
10+
11+
.. step:: Select a chart.
12+
13+
From the dashboard, click :icon-mms:`ellipsis` at the top-right of
14+
the chart to access its embedding information. Select
15+
:guilabel:`Embed chart` from the dropdown menu.
16+
17+
.. include:: /includes/fact-charts-in-embedded-dashboards.rst
18+
19+
.. step:: Enable external sharing on the data source.
20+
21+
If you've already enabled external sharing on the data source
22+
this chart uses, skip this step. If you haven't yet enabled
23+
eexternal sharing on the data source, you can do so now. Click the
24+
:guilabel:`Configure external sharing` link.
25+
26+
.. step:: Enabled signed authentication.
27+
28+
a. Select the :guilabel:`Verified Signature` tab in the dialog
29+
box.
30+
31+
#. Toggle :guilabel:`Enable signed authentication access` to
32+
:guilabel:`On`.
33+
34+
The |html| code that appears in the modal window shows the
35+
required parameters for sharing a chart with
36+
authentication enabled. To use this code, you must continue with
37+
the subsequent steps to enable authenticated access.
38+
39+
.. step:: Acquire an embedding key.
40+
41+
a. Click :guilabel:`Embedding` in the sidebar.
42+
43+
#. Click the :guilabel:`Authentication Settings` tab.
44+
45+
.. note::
46+
47+
You must be a :ref:`Project Owner <dashboard-permissions>` to
48+
access the :guilabel:`Authentication Settings` page. As a
49+
non-admin user, you can still use embedded charts, but you
50+
must get a key from a Project Owner.
51+
52+
.. step:: Generate an embedding key.
53+
54+
Click the :guilabel:`Generate New Key` button to create a new
55+
embedding key. Store the key in a safe place.
56+
57+
.. warning::
58+
59+
If you generate a new key, any previous keys become invalid.
60+
Ensure that all the existing shared charts that use the old key
61+
are updated to use the new key.
62+
63+
.. step:: Create the server-side code necessary for a verified signature.
64+
65+
Generating a verified signature to accompany data requests from
66+
shared charts with authentication enabled requires server-side
67+
code. The verified signature creates a payload by generating a
68+
:wikipedia:`HMAC </HMAC>` from your embedding key, a timestamp,
69+
and identifying data from your chart. The verified signature is
70+
valid for a limited time period specified in your server-side
71+
code.
72+
73+
Code examples demonstrating how to generate a verified
74+
signature are available for the following languages and platforms:
75+
76+
- :github:`Node.js
77+
</mongodb/charts-embedding-examples/tree/master/node>`
78+
- :github:`C#
79+
</mongodb/charts-embedding-examples/tree/master/c-sharp>`
80+
- :github:`Java
81+
</mongodb/charts-embedding-examples/tree/master/java>`
82+
- :github:`Python
83+
</mongodb/charts-embedding-examples/tree/master/python>`
84+
- :github:`MongoDB Stitch
85+
</mongodb/charts-embedding-examples/tree/master/stitch>`
86+

source/includes/steps-enable-embedding-iframe-verified.yaml

Lines changed: 0 additions & 96 deletions
This file was deleted.

0 commit comments

Comments
 (0)