diff --git a/docs/docsite/rst/userguide/main_menu.rst b/docs/docsite/rst/userguide/main_menu.rst index d8c3bb3a06..4560a7e97b 100644 --- a/docs/docsite/rst/userguide/main_menu.rst +++ b/docs/docsite/rst/userguide/main_menu.rst @@ -14,16 +14,20 @@ The User Interface offers a friendly graphical framework for your IT orchestrati The new AWX User Interface is available for tech preview and is subject to change in a future release. To preview the new UI, click the **Enable Preview of New User Interface** toggle to **On** from the Miscellaneous System option of the Settings menu. .. image:: ../common/images/configure-awx-system-misc-preview-newui.png + :alt: Enabling preview of new user interface After saving, logout and log back in to access the new UI from the preview banner. To return to the current UI, click the link on the top banner where indicated. .. image:: ../common/images/ug-dashboard-preview-banner.png + :alt: An image of a dashboard with the word dashboard Across the top-right side of the interface, you can access your user profile, the About page, view related documentation, and log out. Right below these options, you can view the activity stream for that user by clicking on the Activity Stream |activitystream| button. .. |activitystream| image:: ../common/images/activitystream.png + :alt: It shows image of activity stream icon .. image:: ../common/images/ug-dashboard-top-nav.png + :alt: It shows an image of AWX dashboard with Activity Screen icon @@ -57,6 +61,7 @@ Dashboard view The **Dashboard** view begins with a summary of your hosts, inventories, and projects. Each of these is linked to the corresponding objects for easy access. .. image:: ../common/images/ug-dashboard-topsummary.png + :alt: An image of Job Status analytics dashboard On the main Dashboard screen, a summary appears listing your current **Job Status**. The **Job Status** graph displays the number of successful and failed jobs over a specified time period. You can choose to limit the job types that are viewed, and to change the time horizon of the graph. @@ -66,10 +71,12 @@ Also available for view are summaries of **Recent Jobs** and **Recent Templates* The **Recent Jobs** section displays which jobs were most recently run, their status, and time when they were run as well. .. image:: ../common/images/ug-dashboard-recent-jobs.png + :alt: It shows a summary of the most recently used jobs The **Recent Templates** section of this display shows a summary of the most recently used templates. You can also access this summary by clicking **Templates** from the left navigation bar. .. image:: ../common/images/ug-dashboard-recent-templates.png + :alt: It shows a summary of the most recently used templates .. note:: @@ -83,6 +90,7 @@ Jobs view Access the **Jobs** view by clicking **Jobs** from the left navigation bar. This view shows all the jobs that have ran, including projects, templates, management jobs, SCM updates, playbook runs, etc. .. image:: ../common/images/ug-dashboard-jobs-view.png + :alt: It shows all the jobs that have ran, including projects, templates, management jobs, SCM updates, playbook runs, etc. Schedules view @@ -92,6 +100,7 @@ Access the Schedules view by clicking **Schedules** from the left navigation bar .. image:: ../common/images/ug-dashboard-schedule-view.png + :alt: It shows all the scheduled jobs that are configured .. _ug_activitystreams: @@ -110,15 +119,18 @@ Most screens have an Activity Stream (|activitystream|) button. Clicking this br |Users - Activity Stream| .. |Users - Activity Stream| image:: ../common/images/users-activity-stream.png + :alt: It shows a summary of the recent activity on Activity Stream dashboard. An Activity Stream shows all changes for a particular object. For each change, the Activity Stream shows the time of the event, the user that initiated the event, and the action. The information displayed varies depending on the type of event. Clicking on the Examine (|examine|) button shows the event log for the change. .. |examine| image:: ../common/images/examine-button.png + :alt: It shows the image of examine button |event log| .. |event log| image:: ../common/images/activity-stream-event-log.png + :alt: It shows the event log of an Activity Stream instance The Activity Stream can be filtered by the initiating user (or the system, if it was system initiated), and by any related object,