Skip to content
Snippets Groups Projects
Unverified Commit c131205f authored by Hugues Verlin's avatar Hugues Verlin Committed by GitHub
Browse files

docs: Update documentation about publishing a dashboard (#32999)

parent b6df88a1
Branches
No related tags found
No related merge requests found
...@@ -12,8 +12,12 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; ...@@ -12,8 +12,12 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
This section is focused on documentation for end-users who will be using Superset This section is focused on documentation for end-users who will be using Superset
for the data analysis and exploration workflow for the data analysis and exploration workflow
(data analysts, business analysts, data (data analysts, business analysts, data
scientists, etc). In addition to this site, [Preset.io](http://preset.io/) maintains an updated set of end-user scientists, etc).
:::tip
In addition to this site, [Preset.io](http://preset.io/) maintains an updated set of end-user
documentation at [docs.preset.io](https://docs.preset.io/). documentation at [docs.preset.io](https://docs.preset.io/).
:::
This tutorial targets someone who wants to create charts and dashboards in Superset. We’ll show you This tutorial targets someone who wants to create charts and dashboards in Superset. We’ll show you
how to connect Superset to a new database and configure a table in that database for analysis. how to connect Superset to a new database and configure a table in that database for analysis.
...@@ -175,23 +179,36 @@ into a position you like onto the underlying grid. ...@@ -175,23 +179,36 @@ into a position you like onto the underlying grid.
Congrats! You’ve successfully linked, analyzed, and visualized data in Superset. There are a wealth Congrats! You’ve successfully linked, analyzed, and visualized data in Superset. There are a wealth
of other table configuration and visualization options, so please start exploring and creating of other table configuration and visualization options, so please start exploring and creating
slices and dashboards of your own slices and dashboards of your own.
ֿ
### Manage access to Dashboards ### Manage access to Dashboards
Access to dashboards is managed via owners (users that have edit permissions to the dashboard) Access to dashboards is managed via owners (users that have edit permissions to the dashboard).
Non-owner users access can be managed two different ways: Non-owner users access can be managed in two different ways. The dashboard needs to be published to be visible to other users.
1. Dataset permissions - if you add to the relevant role permissions to datasets it automatically grants implicit access to all dashboards that uses those permitted datasets 1. Dataset permissions - if you add to the relevant role permissions to datasets it automatically grants implicit access to all dashboards that uses those permitted datasets.
2. Dashboard roles - if you enable **DASHBOARD_RBAC** [feature flag](/docs/configuration/configuring-superset#feature-flags) then you be able to manage which roles can access the dashboard 2. Dashboard roles - if you enable [**DASHBOARD_RBAC** feature flag](/docs/configuration/configuring-superset#feature-flags) then you will be able to manage which roles can access the dashboard
- Granting a role access to a dashboard will bypass dataset level checks. Having dashboard access implicitly grants read access to all the featured charts in the dashboard, and thereby also all the associated datasets. - Granting a role access to a dashboard will bypass dataset level checks. Having dashboard access implicitly grants read access to all the featured charts in the dashboard, and thereby also all the associated datasets.
- If no roles are specified for a dashboard, regular **Dataset permissions** will apply. - If no roles are specified for a dashboard, regular **Dataset permissions** will apply.
<img src={useBaseUrl("/img/tutorial/tutorial_dashboard_access.png" )} /> <img src={useBaseUrl("/img/tutorial/tutorial_dashboard_access.png" )} />
### Publishing a Dashboard
If you would like to make your dashboard available to other users, click on the `Draft` button next to the
title of your dashboard.
<img src={useBaseUrl("/img/tutorial/publish_button_dashboard.png" )} />
:::warning
Draft dashboards are only visible to the dashboard owners and admins. Published dashboards are visible to all users with access to the underlying datasets or if RBAC is enabled, to the roles that have been granted access to the dashboard.
:::
### Mark a Dashboard as Favorite
You can mark a dashboard as a favorite by clicking on the star icon next to the title of your dashboard. This makes it easier to find it in the list of dashboards or on the home page.
### Customizing dashboard ### Customizing dashboard
The following URL parameters can be used to modify how the dashboard is rendered: The following URL parameters can be used to modify how the dashboard is rendered:
......
docs/static/img/tutorial/publish_button_dashboard.png

83.9 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment