Skip to content

Commit 200dd30

Browse files
DOCSP-35122 dashboard ownership (#636)
* added dashboard ownership steps
1 parent fcca6f5 commit 200dd30

File tree

2 files changed

+109
-0
lines changed

2 files changed

+109
-0
lines changed

source/dashboard-ownership.txt

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
.. _dashboard-ownership:
2+
3+
===================
4+
Dashboard Ownership
5+
===================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can :ref:`view <view-dashboard-owners>`, :ref:`add
16+
<add-dashboard-owners>`, or :ref:`remove <remove-dashboard-owners>`
17+
dashboard owners to any dashboard in your project.
18+
19+
Prerequisites
20+
-------------
21+
22+
You must have the :authrole:`Project Owner` role.
23+
24+
.. _view-dashboard-owners:
25+
26+
View Dashboard Owners
27+
---------------------
28+
29+
To view the owners of any dashboard in your project:
30+
31+
.. procedure::
32+
:style: normal
33+
34+
.. step:: Click :guilabel:`Charts` in the navigation bar to navigate to |charts|.
35+
36+
.. step:: Click :guilabel:`Owners` under :guilabel:`Dashboards` in the sidebar.
37+
38+
|charts| displays a table with the following columns:
39+
40+
.. list-table::
41+
:header-rows: 1
42+
:stub-columns: 1
43+
:widths: 25 75
44+
45+
* - Column Name
46+
- Description
47+
48+
* - :guilabel:`Dashboard title`
49+
- Title of the dashboard.
50+
51+
* - :guilabel:`Dashboard ID`
52+
- ``ID`` of the dashboard.
53+
54+
* - :guilabel:`Dashboard owners`
55+
- Email associated with each dashboard owner.
56+
57+
If an existing dashboard owner was the only owner, and
58+
no longer has access to the project anymore, the
59+
:guilabel:`Dashboard owners` column will say ``No owners``.
60+
61+
You can sort this table by the :guilabel:`Dashboard title` column.
62+
If a dashboard owner omits the :guilabel:`Dashboard title`,
63+
|charts| sorts by the :guilabel:`Dashboard ID`.
64+
65+
.. _add-dashboard-owners:
66+
67+
Add a Dashboard Owner
68+
---------------------
69+
70+
To add a dashboard owner to a dashboard in your project:
71+
72+
.. procedure::
73+
:style: normal
74+
75+
.. step:: Navigate to :ref:`view dashboard owners <view-dashboard-owners>`.
76+
77+
.. step:: Click the pencil icon :icon-fa4:`pencil` for the dashboard you want to add an owner to.
78+
79+
.. step:: Type the email of the person you want to make an owner of the dashboard.
80+
81+
.. note::
82+
83+
This person must have at least ``Viewer`` :doc:`permissions
84+
<dashboard-permissions>` on the dashboard.
85+
86+
.. step:: Click :guilabel:`Save`.
87+
88+
.. _remove-dashboard-owners:
89+
90+
Remove a Dashboard Owner
91+
------------------------
92+
93+
To remove a dashboard owner from a dashboard in your project:
94+
95+
.. procedure::
96+
:style: normal
97+
98+
.. step:: Navigate to :ref:`view dashboard owners <view-dashboard-owners>`.
99+
100+
.. step:: Click the pencil icon :icon-fa4:`pencil` for the dashboard you want to remove an owner from.
101+
102+
.. step:: Click the :guilabel:`x` next to the person's email that you want to remove.
103+
104+
.. note::
105+
106+
There must be at least one dashboard owner.
107+
108+
.. step:: Click :guilabel:`Save`.

source/dashboards.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,7 @@ tasks:
361361
.. toctree::
362362
:titlesonly:
363363

364+
/dashboard-ownership
364365
/manage-dashboards
365366
/dashboard-permissions
366367
/scheduled-reports

0 commit comments

Comments
 (0)