From 3d941411d438f77b66d2036edf690c14b459af58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markku=20Leini=C3=B6?= Date: Wed, 10 Jan 2024 23:04:46 +0200 Subject: [PATCH] Fixes #14722: Change references to admin UI to Admin menu (#14743) * Change references to admin UI to Admin menu * Change also for reports and custom scripts * Minor tweaks to help text flow better --------- Co-authored-by: Jeremy Stretch --- .../authentication/microsoft-azure-ad.md | 2 +- docs/administration/authentication/okta.md | 2 +- docs/administration/authentication/overview.md | 4 ++-- docs/configuration/index.md | 2 +- docs/customization/custom-scripts.md | 4 ++-- docs/customization/reports.md | 4 ++-- ...min_ui_run_permission.png => run_permission.png} | Bin 7 files changed, 9 insertions(+), 9 deletions(-) rename docs/media/{admin_ui_run_permission.png => run_permission.png} (100%) diff --git a/docs/administration/authentication/microsoft-azure-ad.md b/docs/administration/authentication/microsoft-azure-ad.md index ee24e8232..a5e24b0c9 100644 --- a/docs/administration/authentication/microsoft-azure-ad.md +++ b/docs/administration/authentication/microsoft-azure-ad.md @@ -73,7 +73,7 @@ You should be redirected to Microsoft's authentication portal. Enter the usernam If successful, you will be redirected back to the NetBox UI, and will be logged in as the AD user. You can verify this by navigating to your profile (using the button at top right). -This user account has been replicated locally to NetBox, and can now be assigned groups and permissions within the NetBox admin UI. +This user account has been replicated locally to NetBox, and can now be assigned groups and permissions by navigating to Admin > Permissions. ## Troubleshooting diff --git a/docs/administration/authentication/okta.md b/docs/administration/authentication/okta.md index ff552d730..67c0ea41b 100644 --- a/docs/administration/authentication/okta.md +++ b/docs/administration/authentication/okta.md @@ -67,4 +67,4 @@ You should be redirected to Okta's authentication portal. Enter the username/ema If successful, you will be redirected back to the NetBox UI, and will be logged in as the Okta user. You can verify this by navigating to your profile (using the button at top right). -This user account has been replicated locally to NetBox, and can now be assigned groups and permissions within the NetBox admin UI. +This user account has been replicated locally to NetBox, and can now be assigned groups and permissions by navigating to Admin > Permissions. diff --git a/docs/administration/authentication/overview.md b/docs/administration/authentication/overview.md index 8a8b8f60b..f81a50c0b 100644 --- a/docs/administration/authentication/overview.md +++ b/docs/administration/authentication/overview.md @@ -2,9 +2,9 @@ ## Local Authentication -Local user accounts and groups can be created in NetBox under the "Authentication and Authorization" section of the administrative user interface. This interface is available only to users with the "staff" permission enabled. +Local user accounts and groups can be created in NetBox under the "Authentication" section in the "Admin" menu. This section is available only to users with the "staff" permission enabled. -At a minimum, each user account must have a username and password set. User accounts may also denote a first name, last name, and email address. [Permissions](../permissions.md) may also be assigned to users and/or groups within the admin UI. +At a minimum, each user account must have a username and password set. User accounts may also denote a first name, last name, and email address. [Permissions](../permissions.md) may also be assigned to users and/or groups under Admin > Permissions. ## Remote Authentication diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 70466d029..6a2ecdc7f 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -46,4 +46,4 @@ The configuration file may be modified at any time. However, the WSGI service (e $ sudo systemctl restart netbox ``` -Configuration parameters which are set via the admin UI (those listed under "dynamic settings") take effect immediately. +Dynamic configuration parameters (those which can be modified via the UI) take effect immediately. diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index 0b1ed11df..e2bc53cfc 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -288,9 +288,9 @@ An IPv4 or IPv6 network with a mask. Returns a `netaddr.IPNetwork` object. Two a ## Running Custom Scripts !!! note - To run a custom script, a user must be assigned via permissions for `Extras > Script`, `Extras > ScriptModule`, and `Core > ManagedFile` objects. They must also be assigned the `extras.run_script` permission. This is achieved by assigning the user (or group) a permission on the Script object and specifying the `run` action in the admin UI as shown below. + To run a custom script, a user must be assigned permissions for `Extras > Script`, `Extras > Script Module`, and `Core > Managed File` objects. They must also be assigned the `extras.run_script` permission. This is achieved by assigning the user (or group) a permission on the Script object and specifying the `run` action in "Permissions" as shown below. - ![Adding the run action to a permission](../media/admin_ui_run_permission.png) + ![Adding the run action to a permission](../media/run_permission.png) ### Via the Web UI diff --git a/docs/customization/reports.md b/docs/customization/reports.md index a821c5da7..8b0fc44f3 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -132,9 +132,9 @@ Once you have created a report, it will appear in the reports list. Initially, r ## Running Reports !!! note - To run a report, a user must be assigned via permissions for `Extras > Report`, `Extras > ReportModule`, and `Core > ManagedFile` objects. They must also be assigned the `extras.run_report` permission. This is achieved by assigning the user (or group) a permission on the Report object and specifying the `run` action in the admin UI as shown below. + To run a report, a user must be assigned permissions for `Extras > Report`, `Extras > Report Module`, and `Core > Managed File` objects. They must also be assigned the `extras.run_report` permission. This is achieved by assigning the user (or group) a permission on the Report object and specifying the `run` action in "Permissions" as shown below. - ![Adding the run action to a permission](../media/admin_ui_run_permission.png) + ![Adding the run action to a permission](../media/run_permission.png) ### Via the Web UI diff --git a/docs/media/admin_ui_run_permission.png b/docs/media/run_permission.png similarity index 100% rename from docs/media/admin_ui_run_permission.png rename to docs/media/run_permission.png