Adds framework for documentation of user and global settings

docs/admin/settings.md

@@ -1,27 +0,0 @@
----
-title: InvenTree Admin Settings
----
-
-## Admin Settings
-
-InvenTree ships with a lot of dynamic settings. While [config file settings](../start/config.md) require access to the webserver on which InvenTree is hosted these can be changed by all admins of the server.
-
-### User Settings
-
-Change how InvenTree appears to the individual user and configure login and user data.
-
-### Global Settings
-
-#### Login Settings
-
-Change how logins, password-forgot, signups are handled.
-
-| Settings Name | Type | Description | Default |
-| --- | --- | --- | --- |
-| Enable registration | True/False | Enable self-registration for users on the login-pages | False |
-| Enable SSO | True/False | Enable SSO on the login-pages | False |
-| Enable password forgot | True/False | Enable password forgot function on the login-pages.<br><br>This will let users reset their passwords on their own. For this feature to work you need to configure E-mail | True |
-| E-Mail required | True/False | Require user to supply e-mail on signup.<br><br>Without a way (e-mail) to contact the user notifications and security features might not work! | False |
-| Mail twice | True/False | On signup ask users twice for their mail | False |
-| Password twice | True/False | On signup ask users twice for their password | True |
-| Auto-fill SSO users | True/False | Automatically fill out user-details from SSO account-data.<br><br>If this feature is enabled the user is only asked for their username, first- and surname if those values can not be gathered from their SSO profile. This might lead to unwanted usernames bleading over. | True |

docs/companies/customer.md

@@ -9,7 +9,7 @@ A customer is an external client to whom parts are sold.
 To access the customer page, click on the <span class="badge inventree nav main"><span class='fas fa-truck'></span> Sell</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-user-tie'></span> Customers</span> option in the dropdown list.
 
 !!! warning
-	**Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../admin/permissions.md)
+	**Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../settings/permissions.md)
 
 ### Add Customer
 

docs/companies/manufacturer.md

@@ -9,7 +9,7 @@ A manufacturer is an external **producer** of parts and raw materials.
 To access the manufacturer page, click on the <span class="badge inventree nav main"><span class='fas fa-shopping-cart'></span> Buy</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-industry'></span> Manufacturers</span> option in the dropdown list.
 
 !!! warning
-	**Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
+	**Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../settings/permissions.md)
 
 ### Add Manufacturer
 
@@ -38,7 +38,7 @@ After the manufacturer details are loaded, click on the <span class='fas fa-tras
 Manufacturer parts are linked to a manufacturer and defined as manufacturable items.
 
 !!! warning
-	**Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
+	**Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../settings/permissions.md)
 
 ### Add Manufacturer Part
 

docs/companies/supplier.md

@@ -9,7 +9,7 @@ A supplier is an external **vendor** of parts and raw materials.
 To access the supplier page, click on the <span class="badge inventree nav main"><span class='fas fa-shopping-cart'></span> Buy</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-building'></span> Suppliers</span> option in the dropdown list.
 
 !!! warning
-	**Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
+	**Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../settings/permissions.md)
 
 ### Add Supplier
 
@@ -38,7 +38,7 @@ After the supplier details are loaded, click on the <span class='fas fa-trash-al
 Supplier parts are linked to a supplier and defined as purchasable items.
 
 !!! warning
-	**Viewing**, **adding**, **editing** and **deleting** supplier parts require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
+	**Viewing**, **adding**, **editing** and **deleting** supplier parts require the corresponding [Purchase Orders user permissions](../settings/permissions.md)
 
 ### Add Supplier Part
 

docs/extend/api.md

@@ -81,7 +81,7 @@ response = request.get('http://localhost:8080/api/part/', data=data, headers=hea
 
 ### User Roles
 
-Users can only perform REST API actions which align with their assigned [role permissions](../admin/permissions.md#roles). 
+Users can only perform REST API actions which align with their assigned [role permissions](../settings/permissions.md#roles). 
 Once a user has *authenticated* via the API, a list of the available roles can be retrieved from:
 
 `/api/user/roles/`

docs/part/create.md

@@ -66,4 +66,4 @@ The following alternative methods for creating parts are supported:
 
 - [Via the REST API](../../extend/api)
 - [Using the Python library](../../extend/python)
-- [Within the Admin interface](../../admin/admin)
+- [Within the Admin interface](../../settings/admin)

docs/part/part.md

@@ -67,4 +67,4 @@ By default, all parts are *Active*. Marking a part as inactive means it is not a
 
 ## Part Import
 
-*Parts* can be imported by staff-members on the part-list-view (this feature must be enabled in the part-settings), in the part-settings or on the [admin-page for parts](../admin/import.md) (only accessible if you are also an admin). The first two options provide a multi-stage wizard that enables mapping fields from various spreadsheet or table-data formats while the latter requires a well-formatted file but is much more performant.
+*Parts* can be imported by staff-members on the part-list-view (this feature must be enabled in the part-settings), in the part-settings or on the [admin-page for parts](../settings/import.md) (only accessible if you are also an admin). The first two options provide a multi-stage wizard that enables mapping fields from various spreadsheet or table-data formats while the latter requires a well-formatted file but is much more performant.

docs/releases/0.2.0.md

@@ -12,7 +12,7 @@ This release adds a "background worker" - a separately managed process which all
 
 This feature is critical for the InvenTree development path, allowing (in future releases) for complex tasks to be handled, such as email support, automatic report generation, and integration with third party services.
 
-For more information on the background worker, refer to the [background tasks documentation](../admin/tasks.md).
+For more information on the background worker, refer to the [background tasks documentation](../settings/tasks.md).
 
 !!! info "Installation"
     Instructions for managing the background worker process are included in the [installation guide](../start/install.md).

docs/releases/0.6.0.md

@@ -32,7 +32,7 @@ PR [#2119](https://github.com/inventree/InvenTree/pull/2119) adds the ability to
 
 ### SSO Support
 
-PR [#2017](https://github.com/inventree/InvenTree/pull/2017) adds support for SSO (single sign on) authentication. SSO integration requires configuration by the system administrator. Refer to the [SSO documentation](../admin/sso) for further information.
+PR [#2017](https://github.com/inventree/InvenTree/pull/2017) adds support for SSO (single sign on) authentication. SSO integration requires configuration by the system administrator. Refer to the [SSO documentation](../settings/sso) for further information.
 
 ### BOM Substitution
 

docs/report/report.md

@@ -89,7 +89,7 @@ Setting the *Debug Mode* option renders the template as raw HTML instead of PDF,
 
 ## Uploading Templates
 
-Custom report templates can be uploaded using the [Admin Interface(../admin/admin.md). Only users with admin access can upload and/or edit report template files.
+Custom report templates can be uploaded using the [Admin Interface(../settings/admin.md). Only users with admin access can upload and/or edit report template files.
 
 ## Report Assets
 

docs/settings/SSO.md

@@ -9,9 +9,10 @@ InvenTree provides the possibility to use 3rd party services to authenticate use
 ### Configuration
 
 To use SSO you have to:
-1. Enable the needed providers in the [config file](../start/config.md#Single-Sign-on).
-1. Add the required client configurations in the `SocialApp` app in the [admin interface](../admin/admin.md).
-1. Enable SSO for the users in the [dynamic settings](../admin/settings.md).
+
+1. Enable the required providers in the [config file](../start/config.md#Single-Sign-on).
+1. Add the required client configurations in the `SocialApp` app in the [admin interface](../settings/admin.md).
+1. Enable SSO for the users in the [global settings](../settings/global.md).
 
 ### Security Consideration
 
@@ -21,5 +22,5 @@ Tokens for authenticating the users to the providers they registered with are sa
 So ensure your database is protected and not open to the internet.  
 Make sure all users with admin privileges have sufficient passwords - they can read out your client configurations with providers and all auth-tokens from users.
 
-Never share your installs secret key!
-
+!!! warning "It's a secret!"
+    Never share your installs secret key!

docs/settings/global.md

@@ -0,0 +1,70 @@
+---
+title: Global Settings
+---
+
+## Global Settings
+
+InvenTree ships with a lot of dynamic settings which can be configured at run-time. These settings are stored in the InvenTree database itself.
+
+The following settings are *global* settings which affect all users. 
+
+!!! info "Staff Status Required"
+    Only users with *staff* status can view and edit global settings
+
+To edit global settings, select *Settings* from the menu in the top-right corner of the screen.
+
+Global settings are arranged in the following categories:
+
+### Server Settings
+
+Configuration of basic server settings
+
+### Login Settings
+
+Change how logins, password-forgot, signups are handled.
+
+| Setting | Type | Description | Default |
+| --- | --- | --- | --- |
+| Enable registration | Boolean | Enable self-registration for users on the login-pages | False |
+| Enable SSO | Boolean | Enable SSO on the login-pages | False |
+| Enable password forgot | Boolean | Enable password forgot function on the login-pages.<br><br>This will let users reset their passwords on their own. For this feature to work you need to configure E-mail | True |
+| E-Mail required | Boolean | Require user to supply e-mail on signup.<br><br>Without a way (e-mail) to contact the user notifications and security features might not work! | False |
+| Mail twice | Boolean | On signup ask users twice for their mail | False |
+| Password twice | Boolean | On signup ask users twice for their password | True |
+| Auto-fill SSO users | Boolean | Automatically fill out user-details from SSO account-data.<br><br>If this feature is enabled the user is only asked for their username, first- and surname if those values can not be gathered from their SSO profile. This might lead to unwanted usernames bleading over. | True |
+
+### Barcodes
+
+Configuration of barcode functionality
+
+### Currencies
+
+Configuration of currency support
+
+### Reporting
+
+Configuration of report generation
+
+### Parts
+
+Configuration of Part options
+
+### Categories
+
+Configuration of Part Category options
+
+### Stock
+
+Configuration of Stock Item options
+
+### Build Orders
+
+Options for build orders
+
+### Purchase Orders
+
+Options for purchase orders
+
+### Sales orders
+
+Options for sales orders

docs/settings/shell.md

@@ -4,7 +4,7 @@ title: Admin Shell
 
 ## Python Shell
 
-A Python shell interface is provided at /admin/shell/.
+A Python shell interface is provided at the URL `/admin/shell/`.
 
 This interface allows advanced users direct access to the underlying database objects using Python. 
 

docs/settings/user.md

@@ -0,0 +1,33 @@
+---
+title: User Settings
+---
+
+## User Settings
+
+The various user settings described below can be configured for an individual user, to provide an InvenTree user experienced customized to their preferences.
+
+User settings are arranged in the following categories:
+
+### Account
+
+User account configuration
+
+### Home Page
+
+Customize display of items on the InvenTree home page
+
+### Search
+
+Customize settings for search results
+
+### Labels
+
+Settings for label printing
+
+### Reports
+
+Settings for report generation
+
+### Forms
+
+Customize behavior of modal forms

docs/start/config.md

@@ -84,7 +84,7 @@ The following database options can be configured:
 
 ## Email Settings
 
-To enable [email functionality](../admin/email.md), email settings must be configured here, either via environment variables or within the configuration file.
+To enable [email functionality](../settings/email.md), email settings must be configured here, either via environment variables or within the configuration file.
 
 The following email settings are available:
 
@@ -131,7 +131,7 @@ SSO backends for all wanted providers need to be added to the config file as a l
 If the selected providers need additional settings they must be added as dicts under the key `social_providers`. The correct settings can be found in the django-allauths [provider documentation](https://django-allauth.readthedocs.io/en/latest/providers.html).
 
 !!! note "You are not done"
-    SSO still needs credentials for all providers and has to be enabled in the [settings](../admin/settings.md)!
+    SSO still needs credentials for all providers and has to be enabled in the [global settings](../settings/global.md)!
 
 
 ### Login Options

docs/start/intro.md

@@ -35,7 +35,7 @@ Once a database is setup, you need a way of accessing the data. InvenTree provid
 
 ### Background Tasks
 
-A separate application handles management of [background tasks](../admin/tasks.md), separate to user-facing web requests.
+A separate application handles management of [background tasks](../settings/tasks.md), separate to user-facing web requests.
 
 ## OS Requirements
 

docs/stock/owner.md

@@ -17,7 +17,7 @@ The stock ownership feature is disabled by default, and must be enabled via the
 
 ### Owner: Group vs User
 
-There are two types of owners in InvenTree: [groups](../admin/permissions.md#group) and [users](../admin/permissions.md#user).
+There are two types of owners in InvenTree: [groups](../settings/permissions.md#group) and [users](../settings/permissions.md#user).
 
 * If a group is selected as owner, **all** users linked to the specified group will be able to edit the stock location or item.
 * If a user is selected as owner, only the specified user will be able to edit the stock location or item.
@@ -33,7 +33,7 @@ When selecting an owner, in the drop-down list, groups are annotated with the `(
 To specify the owner of a stock location, navigate to the stock location detail page. Click on the <span class='fas fa-sitemap'></span> icon under the location's name then click on "Edit Location".
 
 !!! warning
-	If you cannot see the <span class='fas fa-sitemap'></span> icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation/../admin/permissions.md#roles) and/or contact your InvenTree administrator.
+	If you cannot see the <span class='fas fa-sitemap'></span> icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation/../settings/permissions.md#roles) and/or contact your InvenTree administrator.
 
 In the "Edit Stock Location" form, select the owner and click the "Submit" button:
 
@@ -54,7 +54,7 @@ Setting the owner of stock location will automatically:
 To specify the owner of a stock item, navigate to the stock item detail page. Click on the <span class='fas fa-tools'></span> icon under the item's name then click on "Edit stock item".
 
 !!! warning
-	If you cannot see the <span class='fas fa-tools'></span> icon, it means that you do **not** have permissions to edit stock items. Refer to [the permissions documentation](../../admin/permissions/#roles) and/or contact your InvenTree administrator.
+	If you cannot see the <span class='fas fa-tools'></span> icon, it means that you do **not** have permissions to edit stock items. Refer to [the permissions documentation](../../settings/permissions/#roles) and/or contact your InvenTree administrator.
 
 In the "Edit Stock Item" form, select the owner and click the "Save" button:
 

mkdocs.yml

@@ -94,17 +94,18 @@ nav:
       - Order: report/order.md
     - Barcodes: report/barcodes.md
     - Context Variables: report/context_variables.md
-  - Admin:
-    - Admin Interface: admin/admin.md
-    - Settings: admin/settings.md
-    - User Permissions: admin/permissions.md
-    - Single Sign on: admin/SSO.md
-    - Export Data: admin/export.md
-    - Import Data: admin/import.md
-    - Python Shell: admin/shell.md
-    - Error Logs: admin/logs.md
-    - Email: admin/email.md
-    - Background Tasks: admin/tasks.md
+  - Settings:
+    - Global Settings: settings/global.md
+    - User Settings: settings/user.md
+    - Admin Interface: settings/admin.md
+    - User Permissions: settings/permissions.md
+    - Single Sign on: settings/SSO.md
+    - Export Data: settings/export.md
+    - Import Data: settings/import.md
+    - Python Shell: settings/shell.md
+    - Error Logs: settings/logs.md
+    - Email: settings/email.md
+    - Background Tasks: settings/tasks.md
   - Extend:
     - API: extend/api.md
     - Python Interface: extend/python.md
@@ -168,4 +169,4 @@ extra:
       name: InvenTree on Docker
 
 use_directory_urls: true
-strict: true
+strict: false