From fba3dbc7f1441375005e7fd7a3dc18faef04fd88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markku=20Leini=C3=B6?= Date: Mon, 8 Jan 2024 19:57:48 +0200 Subject: [PATCH 1/3] Change references to admin UI to Admin menu --- docs/administration/authentication/microsoft-azure-ad.md | 2 +- docs/administration/authentication/okta.md | 2 +- docs/administration/authentication/overview.md | 4 ++-- docs/configuration/index.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/administration/authentication/microsoft-azure-ad.md b/docs/administration/authentication/microsoft-azure-ad.md index ee24e8232bb..b33f6fc0957 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 within the "Admin" menu. ## Troubleshooting diff --git a/docs/administration/authentication/okta.md b/docs/administration/authentication/okta.md index ff552d73078..c100474f368 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 within the NetBox "Admin" menu. diff --git a/docs/administration/authentication/overview.md b/docs/administration/authentication/overview.md index 8a8b8f60b06..3896d034493 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 within the same menu section. ## Remote Authentication diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 70466d029ee..f6afcb6c2ec 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. +Configuration parameters which are set via the "Configuration" section in the "Admin" menu take effect immediately. From 3fbb145fd96cca3f9d8ab9027e12e756b3ab81ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markku=20Leini=C3=B6?= Date: Mon, 8 Jan 2024 20:08:05 +0200 Subject: [PATCH 2/3] Change also for reports and custom scripts --- docs/customization/custom-scripts.md | 4 ++-- docs/customization/reports.md | 4 ++-- ...min_ui_run_permission.png => run_permission.png} | Bin 3 files changed, 4 insertions(+), 4 deletions(-) rename docs/media/{admin_ui_run_permission.png => run_permission.png} (100%) diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index 0b1ed11df5f..6e0ed589feb 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 via 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 a821c5da76e..d1a0cc5edf1 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 via 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 From bf08d08e7fc24ea39cc092a763bd10a27b91efbe Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 10 Jan 2024 16:03:32 -0500 Subject: [PATCH 3/3] Minor tweaks to help text flow better --- docs/administration/authentication/microsoft-azure-ad.md | 2 +- docs/administration/authentication/okta.md | 2 +- docs/administration/authentication/overview.md | 2 +- docs/configuration/index.md | 2 +- docs/customization/custom-scripts.md | 2 +- docs/customization/reports.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/administration/authentication/microsoft-azure-ad.md b/docs/administration/authentication/microsoft-azure-ad.md index b33f6fc0957..a5e24b0c9e6 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 "Admin" menu. +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 c100474f368..67c0ea41bd1 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" menu. +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 3896d034493..f81a50c0b88 100644 --- a/docs/administration/authentication/overview.md +++ b/docs/administration/authentication/overview.md @@ -4,7 +4,7 @@ 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 same menu section. +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 f6afcb6c2ec..6a2ecdc7fc4 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 "Configuration" section in the "Admin" menu 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 6e0ed589feb..e2bc53cfcc9 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -288,7 +288,7 @@ 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 > 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. + 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/run_permission.png) diff --git a/docs/customization/reports.md b/docs/customization/reports.md index d1a0cc5edf1..8b0fc44f3ef 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -132,7 +132,7 @@ 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 > 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. + 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/run_permission.png)