ocket8888 commented on a change in pull request #3919: TP: adds a better view for comparing/managing params of 2 profiles URL: https://github.com/apache/trafficcontrol/pull/3919#discussion_r324340026
########## File path: docs/source/admin/quick_howto/profile_compare_mgmt.rst ########## @@ -0,0 +1,46 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _profile_compare_mgmt: + +******************************* +Profile Comparison / Management +******************************* +In Traffic Portal *all* users can compare the parameters of any 2 profiles side-by-side, and users with higher level permissions ("operations" or "admin") can easily add or remove parameters from each profile as necessary. + +The ability to compare and manage 2 profiles can be found under :menuselection:`Configure --> Profiles --> More --> Compare Profiles` + +.. figure:: profile_compare_mgmt/compare_profiles_menu.png + :align: center + :alt: A screenshot of the `Compare Profiles` menu item + + The `Compare Profiles` menu item + +Once you have selected the `Compare Profiles` menu item, you will be asked to choose 2 profiles to compare. + +.. figure:: profile_compare_mgmt/select_profiles_dialog.png + :width: 60% + :align: center + :alt: A screenshot of the `Compare Profile Parameters` dialog + + The `Compare Profile Parameters` dialog + +A superset of all parameters across the 2 profiles will be displayed with their profile membership displayed side-by-side. This view also provides users with higher level permissions ("operations" or "admin") the ability to easily remove or add parameters for each profile and persist the final state of both profiles (or restore the original state and discard changes). In addition, as the user makes changes, a visual indication is provided as modified checkboxes turn red. + +.. figure:: profile_compare_mgmt/compare_profiles_table.png Review comment: It'd be nice if this screenshot included a changed parameter, to show readers what what you mean by "modified checkboxes turn red". I'd expect people to get it anyway, but it's still nice to let them know ahead of time what it looks like. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
