From c95ec9d47cafe7d5585697b01f5506f35c7e15d8 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 12 Oct 2021 21:34:26 +1100 Subject: [PATCH 01/19] Update migrate.md --- docs/start/migrate.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/start/migrate.md b/docs/start/migrate.md index e45a9d8..d41842f 100644 --- a/docs/start/migrate.md +++ b/docs/start/migrate.md @@ -43,6 +43,9 @@ This ensures that the required database tables exist, which must be the case bef The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database. +!!! warning "Empty Database" + If the database is not *empty* (i.e. it contains data records) then the data import process will fail. If errors occur during the import process, run `invoke delete-data` to clear all existing data from the database. + ``` inv import-records -f data.json ``` From 07bc94ed10e1a9a31b4c83c94287e5ba5f285582 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 12 Oct 2021 21:46:22 +1100 Subject: [PATCH 02/19] Update docker.md --- docs/start/docker.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/start/docker.md b/docs/start/docker.md index 6508ea1..810acf4 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -8,6 +8,9 @@ The most convenient method of installing and running InvenTree is to use the off The InvenTree docker image contains all the required system packages, python modules, and configuration files for running a containerised InvenTree web server. +!!! warning "Docker Compose Version" + Tthe following guide is designed to work with docker-compose v1.x. There are currently known issues with docker-compose v2 support. If you are having issues with the docker installation guide, check the version of docker-compose you are running with the command `docker-compose --version`. + ### Environment Variables InvenTree run-time configuration options described in the [configuration documentation](./config.md) can be passed to the InvenTree container as environment variables. From d71ac391681f2728be67786a9ee5f8da5767c601 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 12 Oct 2021 21:46:52 +1100 Subject: [PATCH 03/19] Update docker.md --- docs/start/docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/start/docker.md b/docs/start/docker.md index 810acf4..268dfba 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -9,7 +9,7 @@ The most convenient method of installing and running InvenTree is to use the off The InvenTree docker image contains all the required system packages, python modules, and configuration files for running a containerised InvenTree web server. !!! warning "Docker Compose Version" - Tthe following guide is designed to work with docker-compose v1.x. There are currently known issues with docker-compose v2 support. If you are having issues with the docker installation guide, check the version of docker-compose you are running with the command `docker-compose --version`. + Tthe following guide is designed to work with docker-compose v1.x. There are currently known issues with [docker-compose v2 support](https://github.com/docker/compose/releases/tag/v2.0.0). If you are having issues with the docker installation guide, check the version of docker-compose you are running with the command `docker-compose --version`. ### Environment Variables From 6d2dbcbbfd45a79657ef406f3659d119ae13fdae Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 12 Oct 2021 23:42:21 +0200 Subject: [PATCH 04/19] reference to upcoming site in release notes --- docs/releases/release_notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/release_notes.md b/docs/releases/release_notes.md index 0c3ae57..5886019 100644 --- a/docs/releases/release_notes.md +++ b/docs/releases/release_notes.md @@ -70,7 +70,7 @@ Tagged released are shown below. Click on the release notes for each version to ## Upcoming Features -In-progress and upcoming features can be viewed on [GitHub](https://github.com/inventree/inventree/pulls), where the InvenTree source code is hosted. +In-progress and upcoming features can be viewed on [GitHub](https://github.com/inventree/inventree/pulls), where the InvenTree source code is hosted. Main roadmap items are highlighted in [In Development](./upcoming.md). ## Suggest Something New From 0c7fc041524505636690ebbf0a4c0c30b1995ba3 Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 12 Oct 2021 23:43:24 +0200 Subject: [PATCH 05/19] remove sso as upcoming --- docs/upcoming.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/upcoming.md b/docs/upcoming.md index 2f4ec03..25b26ad 100644 --- a/docs/upcoming.md +++ b/docs/upcoming.md @@ -22,13 +22,3 @@ There are a lot of planned features / improvements for integrated barcode suppor ## Third Party Integrations Work is planned on a plugin system to allow integration with third party applications (such as Xero, Open Cart etc). - -### SSO Login - -Allow SSO integration and login support - -References: - -- [#625](https://github.com/inventree/InvenTree/issues/625) -- [#634](https://github.com/inventree/InvenTree/issues/634) -- [#1693](https://github.com/inventree/InvenTree/issues/1693) \ No newline at end of file From 74e26573a9953ee37fd783910f8d5e291aa9a12b Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 12 Oct 2021 23:44:39 +0200 Subject: [PATCH 06/19] reference for new plugins --- docs/upcoming.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/upcoming.md b/docs/upcoming.md index 25b26ad..9f7d995 100644 --- a/docs/upcoming.md +++ b/docs/upcoming.md @@ -22,3 +22,7 @@ There are a lot of planned features / improvements for integrated barcode suppor ## Third Party Integrations Work is planned on a plugin system to allow integration with third party applications (such as Xero, Open Cart etc). + +References: + +- [#2037](https://github.com/inventree/InvenTree/issues/2037) From d9a9cf25af17045c9a8e219a3cc38832f1c6e29f Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 12 Oct 2021 23:56:47 +0200 Subject: [PATCH 07/19] add missing credits --- docs/credits.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/credits.md b/docs/credits.md index 87c0140..d554b6c 100644 --- a/docs/credits.md +++ b/docs/credits.md @@ -38,6 +38,12 @@ InvenTree relies on the following Python libraries: | [qrcode](https://pypi.org/project/qrcode/) | BSD | QR code support | | [django-q](https://pypi.org/project/django-q/) | MIT | Background task manager | | [gunicorn](https://pypi.org/project/gunicorn/) | MIT | Web server | +| [flake8](https://pypi.org/project/flake8/) | MIT | style checking | +| [pep8-naming](https://pypi.org/project/pep8-naming/) | Expat | name checking | +| [coverage](https://pypi.org/project/coverage/) | Apache-2.0 | coverage checking | +| [coveralls](https://pypi.org/project/coveralls/) | MIT | coverage uploader | +| [django-formtools](https://pypi.org/project/django-formtools/) | MIT | better forms / wizards | +| [django-allauth](https://pypi.org/project/django-allauth/) | MIT | SSO for django | ## Frontend libraries From d3441419c7888de333ea01423316b3870285a39f Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Wed, 13 Oct 2021 00:04:27 +0200 Subject: [PATCH 08/19] fix link --- docs/releases/release_notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/release_notes.md b/docs/releases/release_notes.md index 5886019..d14a394 100644 --- a/docs/releases/release_notes.md +++ b/docs/releases/release_notes.md @@ -70,7 +70,7 @@ Tagged released are shown below. Click on the release notes for each version to ## Upcoming Features -In-progress and upcoming features can be viewed on [GitHub](https://github.com/inventree/inventree/pulls), where the InvenTree source code is hosted. Main roadmap items are highlighted in [In Development](./upcoming.md). +In-progress and upcoming features can be viewed on [GitHub](https://github.com/inventree/inventree/pulls), where the InvenTree source code is hosted. Main roadmap items are highlighted in [In Development](../..upcoming.md). ## Suggest Something New From d2e94b293cb7a6d7c3ab7c3026e497903fa36fa9 Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Wed, 13 Oct 2021 00:12:11 +0200 Subject: [PATCH 09/19] maybe now fixed? --- docs/releases/release_notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/release_notes.md b/docs/releases/release_notes.md index d14a394..0c8d5af 100644 --- a/docs/releases/release_notes.md +++ b/docs/releases/release_notes.md @@ -70,7 +70,7 @@ Tagged released are shown below. Click on the release notes for each version to ## Upcoming Features -In-progress and upcoming features can be viewed on [GitHub](https://github.com/inventree/inventree/pulls), where the InvenTree source code is hosted. Main roadmap items are highlighted in [In Development](../..upcoming.md). +In-progress and upcoming features can be viewed on [GitHub](https://github.com/inventree/inventree/pulls), where the InvenTree source code is hosted. Main roadmap items are highlighted in [In Development](../upcoming.md). ## Suggest Something New From be9ea6d8c95af9659bb275d9470f3e3b5bb4bfb2 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 14 Oct 2021 00:02:16 +1100 Subject: [PATCH 10/19] Update 0.6.0.md https://github.com/inventree/InvenTree/pull/2150 --- docs/releases/0.6.0.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/releases/0.6.0.md b/docs/releases/0.6.0.md index 6d245bb..8bbddd2 100644 --- a/docs/releases/0.6.0.md +++ b/docs/releases/0.6.0.md @@ -34,6 +34,10 @@ PR [#2119](https://github.com/inventree/InvenTree/pull/2119) adds the ability to 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. +### BOM Substitution + +PR [#2150](https://github.com/inventree/InvenTree/pull/2150) adds support for *Bill of Materials Substitution*. This allows substitute parts to be individually specified against BOM line items, allowing for stock of the substituted parts to be used for build order allocation if the original part is not available. + ### Bug Fixes | Pull Request | Description | From a870e786e1c99716e6f7e0fc47c88bd2bf53a339 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 14 Oct 2021 10:41:12 +1100 Subject: [PATCH 11/19] Update docker.md --- docs/start/docker.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/start/docker.md b/docs/start/docker.md index 268dfba..a6a97b8 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -8,6 +8,21 @@ The most convenient method of installing and running InvenTree is to use the off The InvenTree docker image contains all the required system packages, python modules, and configuration files for running a containerised InvenTree web server. +### Tagged Images + +Docker images are available with the following tags: + +- **inventree:stable** represents the most recent stable release version of InvenTree +- **inventree:latest** represents the most up-to-date *development* version of InvenTree. +- **inventree:** specific tagged images are built for each tagged release of InvenTree + +### Docker Compose + +InvenTree provides sample docker-compose files to get you up and running. + +- A *production* compose file is intended to be used in a production environment, running the web server behind a nginx proxy. +- A *development* compose file provides a simple way to spin up a development environment + !!! warning "Docker Compose Version" Tthe following guide is designed to work with docker-compose v1.x. There are currently known issues with [docker-compose v2 support](https://github.com/docker/compose/releases/tag/v2.0.0). If you are having issues with the docker installation guide, check the version of docker-compose you are running with the command `docker-compose --version`. From 39a6c6f380b59ae0e3793602fd2ee0a3f8be189f Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 14 Oct 2021 10:41:24 +1100 Subject: [PATCH 12/19] Update docker.md --- docs/start/docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/start/docker.md b/docs/start/docker.md index a6a97b8..a6f6c3e 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -14,7 +14,7 @@ Docker images are available with the following tags: - **inventree:stable** represents the most recent stable release version of InvenTree - **inventree:latest** represents the most up-to-date *development* version of InvenTree. -- **inventree:** specific tagged images are built for each tagged release of InvenTree +- **inventree:tag** specific tagged images are built for each tagged release of InvenTree ### Docker Compose From 5def5c86d3637efb6a5fbb7f207f05e6ff79eb12 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 14 Oct 2021 10:41:37 +1100 Subject: [PATCH 13/19] Update docker.md --- docs/start/docker.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/start/docker.md b/docs/start/docker.md index a6f6c3e..6358e8a 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -12,9 +12,9 @@ The InvenTree docker image contains all the required system packages, python mod Docker images are available with the following tags: -- **inventree:stable** represents the most recent stable release version of InvenTree -- **inventree:latest** represents the most up-to-date *development* version of InvenTree. -- **inventree:tag** specific tagged images are built for each tagged release of InvenTree +- **inventree:stable** - represents the most recent stable release version of InvenTree +- **inventree:latest** - represents the most up-to-date *development* version of InvenTree. +- **inventree:tag** - specific tagged images are built for each tagged release of InvenTree ### Docker Compose From ad88d1a1d3089e08b9000cd7e4f44bda23767c29 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sat, 16 Oct 2021 14:43:54 +1100 Subject: [PATCH 14/19] Update 0.6.0.md https://github.com/inventree/InvenTree/pull/2159 --- docs/releases/0.6.0.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/releases/0.6.0.md b/docs/releases/0.6.0.md index 8bbddd2..f7c1b8d 100644 --- a/docs/releases/0.6.0.md +++ b/docs/releases/0.6.0.md @@ -38,6 +38,10 @@ PR [#2017](https://github.com/inventree/InvenTree/pull/2017) adds support for SS PR [#2150](https://github.com/inventree/InvenTree/pull/2150) adds support for *Bill of Materials Substitution*. This allows substitute parts to be individually specified against BOM line items, allowing for stock of the substituted parts to be used for build order allocation if the original part is not available. +### Build Completion + +PR [#2159](https://github.com/inventree/InvenTree/pull/2159) provides a major improvement to the process by which build outputs are completed. The build output completion process now uses the API and provides a much more intuitive and efficient user interface. + ### Bug Fixes | Pull Request | Description | From 927fde3dcd7bad38006cba9792410687f0ba7909 Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 18 Oct 2021 08:47:08 +1100 Subject: [PATCH 15/19] Update docker_prod.md --- docs/start/docker_prod.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/start/docker_prod.md b/docs/start/docker_prod.md index f2dca15..7b98de2 100644 --- a/docs/start/docker_prod.md +++ b/docs/start/docker_prod.md @@ -214,6 +214,17 @@ docker-compose pull This ensures that the InvenTree containers will be running the latest version of the InvenTree source code. +!!! info "Tagged Version" + If you are targetting a particular "tagged" version of InvenTree, you may wish to edit your docker-compose file before issuing the `docker-compose pull` command + +### Update Database + +Run the following command to ensure that the InvenTree database is updated: + +``` +docker-compose run inventree-server invoke update +``` + ### Start Containers Now restart the containers. From 48d2a11318207cf9ea662d750bd92724f0174d8e Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 18 Oct 2021 08:50:37 +1100 Subject: [PATCH 16/19] Update docker_prod.md --- docs/start/docker_prod.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/start/docker_prod.md b/docs/start/docker_prod.md index 7b98de2..7f749fc 100644 --- a/docs/start/docker_prod.md +++ b/docs/start/docker_prod.md @@ -227,9 +227,7 @@ docker-compose run inventree-server invoke update ### Start Containers -Now restart the containers. - -As part of the server initialization process, data migrations and static file updates will be performed automatically. +Now restart the docker containers: ``` docker-compose up -d From 0d1e4fdf040e156677299a49fca0fd58fd2f2919 Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 18 Oct 2021 22:12:15 +1100 Subject: [PATCH 17/19] 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 From 2a0950a386e05a5ad980243191398d2e8fc4c269 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 19 Oct 2021 09:41:51 +1100 Subject: [PATCH 18/19] Update mkdocs.yml Make "strict" true again --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 83d9d02..cb607f0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -169,4 +169,4 @@ extra: name: InvenTree on Docker use_directory_urls: true -strict: false +strict: true From e9ed55afd4b25173ee8bffe5724463ddaf83d03f Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 19 Oct 2021 10:49:32 +1100 Subject: [PATCH 19/19] Add release notes to 0.5.2 --- docs/releases/0.5.2.md | 14 ++++++++++++++ docs/releases/release_notes.md | 1 + mkdocs.yml | 2 +- 3 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docs/releases/0.5.2.md diff --git a/docs/releases/0.5.2.md b/docs/releases/0.5.2.md new file mode 100644 index 0000000..0070597 --- /dev/null +++ b/docs/releases/0.5.2.md @@ -0,0 +1,14 @@ +--- +title: Release 0.5.2 +--- + +## Release 0.5.2 + +Release 0.5.2 is a bug-fix release on the 0.5.x stable branch + +### Bug Fixes + +| Pull Request | Description | +| --- | --- | +| [#2145](https://github.com/inventree/InvenTree/pull/2145) | Fixed UI bug which resulted in menu items being hidden after updating InvenTree | +| Commit f33353 | Allows empty barcode field when receiving purchase order items via the API | diff --git a/docs/releases/release_notes.md b/docs/releases/release_notes.md index 0c8d5af..d60374e 100644 --- a/docs/releases/release_notes.md +++ b/docs/releases/release_notes.md @@ -28,6 +28,7 @@ Tagged released are shown below. Click on the release notes for each version to | Release | Date | GitHub | Docker | | --- | --- | --- | --- | +| [0.5.2](./0.5.2.md) | 2021-10-19 | [0.5.2](https://github.com/inventree/InvenTree/releases/tag/0.5.2) | [inventree:0.5.2](https://hub.docker.com/layers/inventree/inventree/0.5.2/images/sha256-ff4f435df894c5aa5ea18ee7f3637e81a29ed356ed82dba70ecbd28da3e3d965?context=explore) | | [0.5.1](./0.5.1.md) | 2021-10-11 | [0.5.1](https://github.com/inventree/InvenTree/releases/tag/0.5.1) | [inventree:0.5.1](https://hub.docker.com/layers/inventree/inventree/0.5.1/images/sha256-3dbfb2e1bc73a0ff2bf537b56f7151c98097923cf77f5313a2a914586ab75973?context=explore) | | [0.5.0](./0.5.0.md) | 2021-10-1 | [0.5.0](https://github.com/inventree/InvenTree/releases/tag/0.5.0) | [inventree:0.5.0](https://hub.docker.com/layers/inventree/inventree/0.5.0/images/sha256-eed8b5df1512d4f1f8596d782d894f8e582c0978d0109020da3ee852bb9326ee?context=explore) | diff --git a/mkdocs.yml b/mkdocs.yml index 83d9d02..cb607f0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -169,4 +169,4 @@ extra: name: InvenTree on Docker use_directory_urls: true -strict: false +strict: true