1.30 release (#522)

* DOCSP-18955 documentation for query library (#519)

* DOCSP-18955 documentation for query library

* DOCSP-18955 updates for copy review feedback

* DOCSP-18955 update for tom's feedback

* DOCSP-18955 second round of updates for feedback

* DOCSP-18955 change page title

* DOCSP-20630 update doc for chart data export (#520)

* DOCSP-20630 update doc for chart data export

* DOCSP-20630 updates for copy review feedback

* (DOCSP-18973), (DOCSP-18974), (DOCSP-18975), (DOCSP-19073): Updated with Dashboard Embedding details. (#521)

* (DOCSP-18973), (DOCSP-18974), (DOCSP-18975), (DOCSP-19073): Updated with Dashboard Embedding details

* (DOCSP-18973): Second pass.

* (DOCSP-18973): Incorporated Kanchana's feedback.

* (DOCSP-18973): Copy feedback pt.2.

* (DOCSP-18973): Incorporated Tom's feedback.

* (DOCSP-18973): Incorporated Tom's feedback pt. 2

* (DOCSP-18973): Incorporated Tom's feedback pt. 3

* (DOCSP-28973): Incorporated Tom's final comment.

Co-authored-by: kanchana-mongodb <[email protected]>

Author: corryroot

snooty.toml

@@ -13,7 +13,9 @@ toc_landing_pages = ["/installation", "/dashboards", "/data-sources",
                      "/chart-type-reference/choropleth",
                      "/customize-charts", 
                      "/customize-charts/conditional-formatting",
-                     "/embedding-charts", 
+                     "/embed-charts-and-dashboards",
+                     "/embedding-charts",
+                     "/embedding-dashboards",
                      "/view-export-chart-data", 
                      "/embedding-tutorials",
                      "/embedding-charts-sdk",

source/aggregation-pipeline.txt

@@ -22,7 +22,16 @@ To create an aggregation pipeline:
 
 1. In the :guilabel:`Query` bar, input an aggregation pipeline. Your
    pipeline must be in square brackets.
-   
+
+#. (Optional) Select :guilabel:`Format` to arrange the query as 
+   follows: 
+
+   -  Split the query across multiple lines
+   -  Indent the query as per JSON conventions
+
+#. (Conditional) If you selected the :guilabel:`Format` option, click 
+   :guilabel:`Close` when you finish. 
+
 #. Click :guilabel:`Apply` to execute your pipeline.
 
 Example

source/charts-embedding-sdk.txt

@@ -0,0 +1,34 @@
+.. _charts-embedding-sdk:
+
+===================================
+Embed Charts with the Embedding SDK
+===================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can embed a chart into a web application with the :ref:`Embedding
+SDK <embedding-charts-sdk>`, which allows you to make more flexible 
+adjustments to chart settings and rendering.
+
+You can use the embedding SDK to do the following tasks:
+
+- Add filters dynamically
+- Change the size and style of the chart
+- Refresh on demand
+
+To embed a chart with the SDK, you need to:
+
+1. Enable embedding for the chart.
+#. Allow :ref:`embedded chart filtering <embed-options-filter>` on 
+   certain fields by :ref:`specifying filterable fields 
+   <specify-filter-fields>`. Don't include fields that may reveal 
+   sensitive data. 
+#. Have the chart ID and base URL strings.
+
+To learn more, see :ref:`get-started-embedding-sdk`.

source/configure-auth-providers.txt

@@ -13,9 +13,15 @@ Configure Embedding Authentication Providers
    :class: singlecol
 
 |charts| uses tokens passed with the Embedding SDK to authenticate users
-who want to view authenticated embedded charts. If the details in the 
-token do not match criteria you specify, if the token is invalid, 
-or if a token is not present, |charts-short| doesn't render the chart.
+who want to view embedded charts or dashboards that require 
+authentication.
+
+|charts-short| doesn't render the chart or dashboard in any of the 
+following scenarios:
+
+- The details in the token don't match criteria you specify.
+- The token is invalid.
+- A token isn't present.
 
 Considerations
 --------------

source/dashboard-refresh.txt

@@ -30,7 +30,8 @@ To configure auto-refresh settings for a dashboard:
 
 1. Select a dashboard from the :guilabel:`Dashboards` page.
 
-#. Click :guilabel:`Refresh` at the top of the dashboard.
+#. Click the :guilabel:`Refresh` icon at 
+   the top of the dashboard.
 
 #. Click :guilabel:`Auto Refresh Settings` from the dropdown.
 
@@ -61,7 +62,7 @@ To manually refresh dashboard data:
 
 1. Select a dashboard from the :guilabel:`Dashboards` page.
 
-#. Click the :guilabel:`Refresh` button.
+#. Click the :guilabel:`Refresh` icon.
 
 #. Select :guilabel:`Force Refresh All Charts` from the dropdown.
 

source/dashboards-embedding-sdk.txt

@@ -0,0 +1,29 @@
+.. _dashboards-embedding-sdk:
+
+=======================================
+Embed Dashboards with the Embedding SDK
+=======================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can embed a dashboard into a web application with the 
+:ref:`Embedding SDK <embedding-charts-sdk>`, which allows you to make 
+more flexible adjustments to dashboard settings and rendering.
+
+You can use the embedding SDK to do the following tasks:
+
+- Change the size and style of the dashboard
+- Refresh on demand
+
+To embed a dashboard with the SDK, you need to:
+
+1. Enable embedding for the dashboard.
+#. Have the dashboard ID and base URL strings.
+
+To learn more, see :ref:`get-started-embedding-sdk`.

source/dashboards.txt

@@ -113,14 +113,11 @@ refresh behavior, see :doc:`/dashboard-refresh`.
 Get Chart Data
 --------------
 
-Authenticated dashboard users can view and export the
-underlying chart data as a table. To view the chart data, click 
-:guilabel:`Get Chart Data` from the :icon-fa5:`ellipsis-h` menu. Each
-row in the table represents a data point.
-
-.. note::
-
-   Users who open a dashboard using a public link can't get chart data.
+The data underlying a chart can be exported as a table. All viewers of 
+public dashboards and authenticated users of non-public dashboards can 
+view and export data. To view the chart data, click :guilabel:`Get 
+Chart Data` from the :icon-fa5:`ellipsis-h` menu. Each row in the table 
+represents a data point.
 
 .. include:: /includes/get-chart-data-details.rst
 
@@ -266,11 +263,8 @@ To enter the fullscreen view for dashboards:
 
 1. Select a dashboard from the :guilabel:`Dashboards` page.
 
-#. Click the expanding arrows at the top-right of the dashboard.
-
-.. figure:: /images/charts/full-screen-view.png
-   :figwidth: 750px
-   :alt: Fullscreen Arrows
+#. Click the :guilabel:`View full screen` (:icon-fa5:`expand`) icon at 
+   the top-right of the dashboard.
 
 .. note::
 
@@ -288,7 +282,8 @@ To enter the fullscreen view for dashboards:
 To exit the fullscreen view for dashboards, do one of the following 
 tasks:
 
-- Click the contracting arrows at the top-right of the dashboard.
+- Click the :guilabel:`Exit full screen` (:icon-fa5:`compress`) icon at 
+  the top-right of the dashboard.
 
 - Press the escape key.
 

source/embed-chart-anon-auth.txt

@@ -43,18 +43,16 @@ Create a Web App to Display Your Chart
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you already have an app in which to display your chart, you're ready
-to add an unauthenticated embedded chart. If not, proceed with the remaining
-steps to create a new app.
+to add an unauthenticated embedded chart. If not, proceed with the 
+remaining steps to create a new app.
 
-MongoDB offers a pre-built example app that shows how to use the 
-Embedding SDK to display an unauthenticated embedded chart.
+.. include:: /includes/fact-create-web-app-anon-chart.rst
 
 Clone the :github:`GitHub repository </mongodb-js/charts-embed-sdk/>`
-to get all the example apps. Instructions for running the unauthenticated
-example are in the :github:`Readme
-</mongodb-js/charts-embed-sdk/tree/master/examples/unauthenticated>` file
-in the ``unauthenticated`` directory. You can run the app as-is, or you can
-customize it to use a chart of your own.
+to get all the example apps. Instructions for running the 
+unauthenticated example are in the :github:`Readme
+</mongodb-js/charts-embed-sdk/tree/master/examples/charts/unauthenticated>` file in the ``unauthenticated`` directory. You can 
+run the app as-is, or you can customize it to use a chart of your own.
 
 Customize the Node.js App
 ~~~~~~~~~~~~~~~~~~~~~~~~~

source/embed-chart-google-auth.txt

@@ -64,7 +64,7 @@ MongoDB offers a pre-built example app that shows how to use the
 Embedding SDK to display an embedded chart using Google authentication.
 
 To run the example app, clone the
-:github:`MongoDB Charts Embedding Example - Google Authentication </mongodb-js/charts-embed-sdk/tree/master/examples/authenticated-google>`
+:github:`MongoDB Charts Embedding Example - Google Authentication </mongodb-js/charts-embed-sdk/tree/master/examples/charts/authenticated-google>`
 repository from GitHub and follow the instructions in the ``Readme`` 
 file to begin using the app. You can run the app as-is with a sample 
 chart, or you can customize it to use an existing chart.

source/embed-chart-jwt-auth.txt

@@ -80,7 +80,7 @@ MongoDB offers a pre-built sample that shows you how to use the
 Embedding SDK to authenticate an embedded chart using a |jwt|.
 
 Clone the :github:`GitHub repository 
-</mongodb-js/charts-embed-sdk/tree/master/examples/authenticated-custom-jwt>`
+</mongodb-js/charts-embed-sdk/tree/master/examples/charts/authenticated-custom-jwt>`
 and follow the instructions in the **Readme** file to begin using the 
 app. You can customize it to use the chart you created earlier.