[Rt-commit] rt 03/04: Update dashboard docs to mention RT at a glance

[Jim Brandt]

This is an automated email from the git hooks/post-receive script.

jbrandt pushed a commit to branch 5.0/use-dashboard-for-homepage-select-ui
in repository rt.

commit 734af4ee76b42308f71013e6a09c3ef829c6c0d0
Author: Jim Brandt <jbrandt at bestpractical.com>
AuthorDate: Thu Jul 8 13:51:39 2021 -0400

    Update dashboard docs to mention RT at a glance
---
 docs/dashboards.pod | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/docs/dashboards.pod b/docs/dashboards.pod
index 0a96521b5d..f3d4373972 100644
--- a/docs/dashboards.pod
+++ b/docs/dashboards.pod
@@ -9,6 +9,20 @@ dashboard and notifications to track outstanding invoice tickets.
 There are several different rights you can grant to allow users access to the 
 features described here. These rights are described in L</"Dashboard Rights">.
 
+=head2 RT at a glance
+
+RT's homepage, called RT at a glance, is a dashboard that has been set as your
+current homepage. By default, all users see the system-level dashboard set by
+the RT administrator. If you have the "ModifySelf" right, you can easily change your
+homepage by clicking on the gear icon. You'll see a page showing you all dashboards
+you currently have access to. Click "View Dashboard" to see what it contains.
+If you have rights, you can use "Edit Dashboard" to update a dashboard. Just
+click the "Set as Homepage" button to change your homepage to a different dashboard.
+
+To create your own custom dashboards and use one as your homepage, you can
+click the "New Dashboard" option in the submenu on the customize page.
+Details on how to set up your new dashboard are provided below.
+
 =head2 Creating a Personal Dashboard
 
 Saved searches and charts are the building blocks of dashboards, so to set up a 
@@ -99,6 +113,13 @@ will be rendered right below the saved search.
 
 =for :man [Dashboard chart F<docs/images/dashboard-chart.png>]
 
+=head2 RT Portlets
+
+RT also provides portlets that you can add to your dashboards. These are
+pre-defined components that provide common searches like "My Tickets" or
+custom functionality like the "QuickCreate" portlet. You'll see these in
+the Components section when you create and modify dashboards.
+
 =head2 Dashboard Menu Entries
 
 In addition to having dashboards available on the "RT at a glance" page, you 
@@ -203,4 +224,10 @@ users to create their own and "View saved searches" (ShowSavedSearches)
 For dashboards themselves, there are See, Create, Modify, and Delete rights for 
 each of personal, group, and system dashboards. This allows you to select the 
 right combination of rights for users and groups on your system. For 
-subscriptions, there is a "Subscribe to dashboards" (SubscribeDashboard) right.
\ No newline at end of file
+subscriptions, there is a "Subscribe to dashboards" (SubscribeDashboard) right.
+
+If you just want to allow users to create dashboards so they can customize
+their homepage, grant "ModifySelf", "SeeOwnDashboard", "ModifyOwnDashboard" and
+"DeleteOwnDashboard". All users can select the current default System dashboard
+and set it as their homepage. To allow users to see other System dashboards,
+grant "SeeDashboard".

-- 
To stop receiving notification emails like this one, please contact
sysadmin at bestpractical.com.