From 0d1e4fdf040e156677299a49fca0fd58fd2f2919 Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 18 Oct 2021 22:12:15 +1100 Subject: [PATCH] Adds framework for documentation of user and global settings --- docs/admin/settings.md | 27 ---------- docs/companies/customer.md | 2 +- docs/companies/manufacturer.md | 4 +- docs/companies/supplier.md | 4 +- docs/extend/api.md | 2 +- docs/part/create.md | 2 +- docs/part/part.md | 2 +- docs/releases/0.2.0.md | 2 +- docs/releases/0.6.0.md | 2 +- docs/report/report.md | 2 +- docs/{admin => settings}/SSO.md | 11 ++-- docs/{admin => settings}/admin.md | 0 docs/{admin => settings}/email.md | 0 docs/{admin => settings}/export.md | 0 docs/settings/global.md | 70 +++++++++++++++++++++++++ docs/{admin => settings}/import.md | 0 docs/{admin => settings}/logs.md | 0 docs/{admin => settings}/permissions.md | 0 docs/{admin => settings}/shell.md | 2 +- docs/{admin => settings}/tasks.md | 0 docs/settings/user.md | 33 ++++++++++++ docs/start/config.md | 4 +- docs/start/intro.md | 2 +- docs/stock/owner.md | 6 +-- mkdocs.yml | 25 ++++----- 25 files changed, 140 insertions(+), 62 deletions(-) delete mode 100644 docs/admin/settings.md rename docs/{admin => settings}/SSO.md (77%) rename docs/{admin => settings}/admin.md (100%) rename docs/{admin => settings}/email.md (100%) rename docs/{admin => settings}/export.md (100%) create mode 100644 docs/settings/global.md rename docs/{admin => settings}/import.md (100%) rename docs/{admin => settings}/logs.md (100%) rename docs/{admin => settings}/permissions.md (100%) rename docs/{admin => settings}/shell.md (91%) rename docs/{admin => settings}/tasks.md (100%) create mode 100644 docs/settings/user.md diff --git a/docs/admin/settings.md b/docs/admin/settings.md deleted file mode 100644 index ca845f8..0000000 --- a/docs/admin/settings.md +++ /dev/null @@ -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.

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.

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.

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 | diff --git a/docs/companies/customer.md b/docs/companies/customer.md index 8a72025..b875062 100644 --- a/docs/companies/customer.md +++ b/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 Sell navigation tab and click on Customers 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 diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md index 84aa909..e6b662f 100644 --- a/docs/companies/manufacturer.md +++ b/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 Buy navigation tab and click on Manufacturers 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 Buy navigation tab and click on Suppliers 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
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.

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.

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 \ No newline at end of file diff --git a/docs/admin/import.md b/docs/settings/import.md similarity index 100% rename from docs/admin/import.md rename to docs/settings/import.md diff --git a/docs/admin/logs.md b/docs/settings/logs.md similarity index 100% rename from docs/admin/logs.md rename to docs/settings/logs.md diff --git a/docs/admin/permissions.md b/docs/settings/permissions.md similarity index 100% rename from docs/admin/permissions.md rename to docs/settings/permissions.md diff --git a/docs/admin/shell.md b/docs/settings/shell.md similarity index 91% rename from docs/admin/shell.md rename to docs/settings/shell.md index 6bdd259..253620a 100644 --- a/docs/admin/shell.md +++ b/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. diff --git a/docs/admin/tasks.md b/docs/settings/tasks.md similarity index 100% rename from docs/admin/tasks.md rename to docs/settings/tasks.md diff --git a/docs/settings/user.md b/docs/settings/user.md new file mode 100644 index 0000000..415a1f6 --- /dev/null +++ b/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 diff --git a/docs/start/config.md b/docs/start/config.md index f7a1c5b..91612c0 100644 --- a/docs/start/config.md +++ b/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 diff --git a/docs/start/intro.md b/docs/start/intro.md index 12dccf8..ab39623 100644 --- a/docs/start/intro.md +++ b/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 diff --git a/docs/stock/owner.md b/docs/stock/owner.md index a940542..f0e5381 100644 --- a/docs/stock/owner.md +++ b/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 icon under the location's name then click on "Edit Location". !!! warning - If you cannot see the 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 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 icon under the item's name then click on "Edit stock item". !!! warning - If you cannot see the 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 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: diff --git a/mkdocs.yml b/mkdocs.yml index cb8a013..83d9d02 100644 --- a/mkdocs.yml +++ b/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