This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 87e2441 Removed the TO UI menu docs, and documented equivalent TP
functionality (#3922)
87e2441 is described below
commit 87e2441d57d781524ad75b2cd29f9e1613807cdb
Author: ocket8888 <[email protected]>
AuthorDate: Wed Oct 2 09:44:59 2019 -0600
Removed the TO UI menu docs, and documented equivalent TP functionality
(#3922)
---
docs/source/admin/traffic_ops/images/12m.png | Bin 22728 -> 0 bytes
docs/source/admin/traffic_ops/using.rst | 32 ------------
.../traffic_portal/images/changelog_dialog.png | Bin 0 -> 39300 bytes
.../admin/traffic_portal/images/changelog_page.png | Bin 0 -> 100430 bytes
.../admin/traffic_portal/images/logout_button.png | Bin 0 -> 2895 bytes
.../admin/traffic_portal/images/popout_button.png | Bin 0 -> 2968 bytes
.../admin/traffic_portal/images/profile_button.png | Bin 0 -> 3699 bytes
.../traffic_portal/images/release_info_button.png | Bin 0 -> 3901 bytes
.../admin/traffic_portal/usingtrafficportal.rst | 54 +++++++++++++++++++++
9 files changed, 54 insertions(+), 32 deletions(-)
diff --git a/docs/source/admin/traffic_ops/images/12m.png
b/docs/source/admin/traffic_ops/images/12m.png
deleted file mode 100644
index 36ce934..0000000
Binary files a/docs/source/admin/traffic_ops/images/12m.png and /dev/null differ
diff --git a/docs/source/admin/traffic_ops/using.rst
b/docs/source/admin/traffic_ops/using.rst
index 112c9bf..4954a7d 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -21,35 +21,3 @@ Traffic Ops - Using
.. deprecated:: 3.0
The Traffic Ops UI is deprecated, and will be removed entirely in the
next major release (4.0). A much better way to interact with the CDN is to
:ref:`use Traffic Portal <usingtrafficportal>`, which is the the only UI that
will be receiving updates for the foreseeable future.
-
-The Traffic Ops Menu
-====================
-.. figure:: images/12m.png
- :align: center
- :alt: The Traffic Ops Landing Page
-
- The Traffic Ops Landing Page
-
-The following tabs are available in the menu at the top of the Traffic Ops
user interface.
-
-.. index::
- Change Log
-
-ChangeLog
----------
-The Changelog table displays the changes that are being made to the Traffic
Ops database through the Traffic Ops user interface. This tab will show the
number of changes since you last visited this tab in (brackets) since the last
time you visited this tab. There are currently no sub menus for this tab.
-
-
-Help
-----
-Help for Traffic Ops and Traffic Control. Hover over this tab to get the
following options:
-
-+---------------+---------------------------------------------------------------------+
-| Option | Description
|
-+===============+=====================================================================+
-| About | Traffic Ops information, such as version, database
information, etc |
-+---------------+---------------------------------------------------------------------+
-| Release Notes | Release notes for the most recent releases of Traffic Ops
|
-+---------------+---------------------------------------------------------------------+
-| Logout | Logout from Traffic Ops
|
-+---------------+---------------------------------------------------------------------+
diff --git a/docs/source/admin/traffic_portal/images/changelog_dialog.png
b/docs/source/admin/traffic_portal/images/changelog_dialog.png
new file mode 100644
index 0000000..e09ea2b
Binary files /dev/null and
b/docs/source/admin/traffic_portal/images/changelog_dialog.png differ
diff --git a/docs/source/admin/traffic_portal/images/changelog_page.png
b/docs/source/admin/traffic_portal/images/changelog_page.png
new file mode 100644
index 0000000..b849897
Binary files /dev/null and
b/docs/source/admin/traffic_portal/images/changelog_page.png differ
diff --git a/docs/source/admin/traffic_portal/images/logout_button.png
b/docs/source/admin/traffic_portal/images/logout_button.png
new file mode 100644
index 0000000..74977b5
Binary files /dev/null and
b/docs/source/admin/traffic_portal/images/logout_button.png differ
diff --git a/docs/source/admin/traffic_portal/images/popout_button.png
b/docs/source/admin/traffic_portal/images/popout_button.png
new file mode 100644
index 0000000..cf051e0
Binary files /dev/null and
b/docs/source/admin/traffic_portal/images/popout_button.png differ
diff --git a/docs/source/admin/traffic_portal/images/profile_button.png
b/docs/source/admin/traffic_portal/images/profile_button.png
new file mode 100644
index 0000000..169b4a8
Binary files /dev/null and
b/docs/source/admin/traffic_portal/images/profile_button.png differ
diff --git a/docs/source/admin/traffic_portal/images/release_info_button.png
b/docs/source/admin/traffic_portal/images/release_info_button.png
new file mode 100644
index 0000000..beca2b0
Binary files /dev/null and
b/docs/source/admin/traffic_portal/images/release_info_button.png differ
diff --git a/docs/source/admin/traffic_portal/usingtrafficportal.rst
b/docs/source/admin/traffic_portal/usingtrafficportal.rst
index 0cabd18..7b37236 100644
--- a/docs/source/admin/traffic_portal/usingtrafficportal.rst
+++ b/docs/source/admin/traffic_portal/usingtrafficportal.rst
@@ -27,6 +27,60 @@ Traffic Portal is the official Traffic Control UI. Traffic
Portal typically runs
Traffic Portal Start Page
+Change Logs
+===========
+At the top-right of every page is a bubble icon and badge count indicating the
number of changes made to the CDN since the last viewing. Clicking on this
expands a short list, with an option to :guilabel:`See All Change Logs`.
Clicking on this will navigate to the "Changelog" page.
+
+.. figure:: images/changelog_dialog.png
+ :width: 15%
+ :align: center
+ :alt: The changelog dialog
+
+ The Changelog Dialog
+
+.. figure:: images/changelog_page.png
+ :width: 45%
+ :align: center
+ :alt: The 'full' change logs page
+
+ The Full Change Logs Page
+
+Sidebar Bottom Buttons
+======================
+At the bottom of the sidebar, a few action buttons may be found. At the far
left, is the :guilabel:`Logout` button.
+
+.. figure:: images/logout_button.png
+ :align: center
+ :alt: The logout button
+
+ The Logout Button
+
+Clicking on this button will cause the current user session to end; further
use of the Traffic Portal UI will require re-authentication. Next to this is
the :guilabel:`User Profile` button.
+
+.. figure:: images/profile_button.png
+ :align: center
+ :alt: The profile button
+
+ The User Profile Button
+
+Clicking on this button will take the user to his or her user profile page,
where much of their information (contact, username etc.) is editable. The next
button to the right is the :guilabel:`Release Info` button.
+
+.. figure:: images/release_info_button.png
+ :align: center
+ :alt: The release info button
+
+ The Release Info Button
+
+When this button is clicked, a modal window will appear, displaying the
Traffic Portal version, the date on which it was built, and the network
location of the Traffic Ops server that serves the :ref:`to-api` used by the
Traffic Portal instance. The final button is the :guilabel:`Popout` button.
+
+.. figure:: images/popout_button.png
+ :align: center
+ :alt: The popout button
+
+ The Popout Button
+
+This button will open the current view in a new browsing context. Most
browsers will implement this as a new tab, but can be configured instead to
open them in a new window - check your browser's configuration and set it as
desired.
+
Dashboard
=========
The Dashboard is the default landing page for Traffic Portal. It provides a
real-time view into the main performance indicators of the CDNs managed by
Traffic Control. It also displays various statistics about the overall health
of your CDN.
