From 1de93c1fbb12e3caba032702673352ab55e8e228 Mon Sep 17 00:00:00 2001 From: eeintech Date: Thu, 5 Nov 2020 12:29:49 -0500 Subject: [PATCH 1/4] Renamed 'Buy' section to 'Companies' Added pages for manufacturer, customer and sales orders documentation --- docs/companies/customer.md | 19 ++++++++++++ docs/companies/manufacturer.md | 33 +++++++++++++++++++++ docs/{buy => companies}/po.md | 0 docs/{buy/supplier.md => companies/so.md} | 8 ++---- docs/companies/supplier.md | 35 +++++++++++++++++++++++ mkdocs.yml | 9 ++++-- 6 files changed, 96 insertions(+), 8 deletions(-) create mode 100644 docs/companies/customer.md create mode 100644 docs/companies/manufacturer.md rename docs/{buy => companies}/po.md (100%) rename docs/{buy/supplier.md => companies/so.md} (52%) create mode 100644 docs/companies/supplier.md diff --git a/docs/companies/customer.md b/docs/companies/customer.md new file mode 100644 index 0000000..cd98529 --- /dev/null +++ b/docs/companies/customer.md @@ -0,0 +1,19 @@ +--- +title: Customers +--- + +## Customers + +A customer is a client who parts are sold to. + +To access the customer page, click on the "Sell" navigation tab and click on "Customers" option in the dropdown list. + +### Add Customer + +!!! missing "TODO" + This section requires further work + +### Edit Customer + +!!! missing "TODO" + This section requires further work diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md new file mode 100644 index 0000000..8e2ef45 --- /dev/null +++ b/docs/companies/manufacturer.md @@ -0,0 +1,33 @@ +--- +title: Manufacturers +--- + +## Manufacturers + +A supplier is an external vendor of parts and raw materials. + +To access the supplier page, click on the "Buy" navigation tab and click on "Manufacturers" option in the dropdown list. + +### Add Manufacturer + +!!! missing "TODO" + This section requires further work + +### Edit Manufacturer + +!!! missing "TODO" + This section requires further work + +## Manufacturer Parts + +Manufacturer parts are linked to a manufacturer and supplier part: they are the "items" sold by a supplier. + +### Add Manufacturer Part + +!!! missing "TODO" + This section requires further work + +### Edit Manufacturer Part + +!!! missing "TODO" + This section requires further work diff --git a/docs/buy/po.md b/docs/companies/po.md similarity index 100% rename from docs/buy/po.md rename to docs/companies/po.md diff --git a/docs/buy/supplier.md b/docs/companies/so.md similarity index 52% rename from docs/buy/supplier.md rename to docs/companies/so.md index 454802e..bc9f5c9 100644 --- a/docs/buy/supplier.md +++ b/docs/companies/so.md @@ -1,15 +1,13 @@ --- -title: Suppliers +title: Sales Order --- -## Suppliers - -A supplier is an external vendor of parts and raw materials. +## Sales Orders !!! missing "TODO" This section requires further work -## Supplier Parts +## Line Items !!! missing "TODO" This section requires further work diff --git a/docs/companies/supplier.md b/docs/companies/supplier.md new file mode 100644 index 0000000..1e0985c --- /dev/null +++ b/docs/companies/supplier.md @@ -0,0 +1,35 @@ +--- +title: Suppliers +--- + +## Suppliers + +A supplier is an external vendor of parts and raw materials. + +To access the supplier page, click on the "Buy" navigation tab and click on "Suppliers" option in the dropdown list. + +### Add Supplier + +Once the supplier page is loaded, click on the "New Supplier" button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) and click on "Submit". + +!!! note "Supplier vs Manufacturer" + In the case the supplier is a manufacturer who sells directly to customers, you may want to enable the checkbox `is manufacturer` before submitting the form (you can also enable it later on). + +### Edit Supplier + +!!! missing "TODO" + This section requires further work + +## Supplier Parts + +Supplier parts are linked to a supplier and defined as purchasable items. + +### Add Supplier Part + +!!! missing "TODO" + This section requires further work + +### Edit Supplier Part + +!!! missing "TODO" + This section requires further work diff --git a/mkdocs.yml b/mkdocs.yml index d08af7a..5793753 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,9 +52,12 @@ nav: - Build: - Build Parts: build/build.md - Bill of Materials (BOM): build/bom.md - - Buy: - - Suppliers: buy/supplier.md - - Purchase Orders: buy/po.md + - Companies: + - Suppliers: companies/supplier.md + - Manufacturers: companies/manufacturer.md + - Customers: companies/customer.md + - Purchase Orders: companies/po.md + - Sales Orders: companies/so.md - Report: - Labels: report/labels.md - Templates: report/report.md From 3c151b5673f10232fb6f83df555ece73a03474ca Mon Sep 17 00:00:00 2001 From: eeintech Date: Thu, 5 Nov 2020 12:49:13 -0500 Subject: [PATCH 2/4] Added more companies documentation --- docs/companies/customer.md | 2 +- docs/companies/manufacturer.md | 12 +++++++----- docs/companies/po.md | 2 ++ docs/companies/so.md | 2 ++ docs/companies/supplier.md | 2 +- 5 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/companies/customer.md b/docs/companies/customer.md index cd98529..3bc46c2 100644 --- a/docs/companies/customer.md +++ b/docs/companies/customer.md @@ -4,7 +4,7 @@ title: Customers ## Customers -A customer is a client who parts are sold to. +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. diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md index 8e2ef45..55e39ce 100644 --- a/docs/companies/manufacturer.md +++ b/docs/companies/manufacturer.md @@ -4,14 +4,16 @@ title: Manufacturers ## Manufacturers -A supplier is an external vendor of parts and raw materials. +A manufacturer is an external **producer** of parts and raw materials. -To access the supplier page, click on the "Buy" navigation tab and click on "Manufacturers" option in the dropdown list. +To access the manufacturer page, click on the "Buy" navigation tab and click on "Manufacturers" option in the dropdown list. ### Add Manufacturer -!!! missing "TODO" - This section requires further work +Once the manufacturer page is loaded, click on the "New Manufacturer" button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) and click on "Submit". + +!!! note "Manufacturer vs Supplier" + In the case the manufacturer sells directly to customers, you may want to enable the checkbox `is supplier` before submitting the form (you can also enable it later on). Purchase orders rely exclusively on [supplier parts](../supplier#supplier-parts), therefore the manufacturer will need to be set as a supplier too. ### Edit Manufacturer @@ -20,7 +22,7 @@ To access the supplier page, click on the "Buy" navigation tab and click on "Man ## Manufacturer Parts -Manufacturer parts are linked to a manufacturer and supplier part: they are the "items" sold by a supplier. +Manufacturer parts are linked to a manufacturer and supplier part: they are the actual "items" sold by a supplier. ### Add Manufacturer Part diff --git a/docs/companies/po.md b/docs/companies/po.md index 7d43c72..e1141e9 100644 --- a/docs/companies/po.md +++ b/docs/companies/po.md @@ -4,6 +4,8 @@ title: Purchase Order ## Purchase Orders +To access the purchase order page, click on the "Buy" navigation tab and click on "Purchase Orders" option in the dropdown list. + !!! missing "TODO" This section requires further work diff --git a/docs/companies/so.md b/docs/companies/so.md index bc9f5c9..632980f 100644 --- a/docs/companies/so.md +++ b/docs/companies/so.md @@ -4,6 +4,8 @@ title: Sales Order ## Sales Orders +To access the sales order page, click on the "Sell" navigation tab and click on "Sales Orders" option in the dropdown list. + !!! missing "TODO" This section requires further work diff --git a/docs/companies/supplier.md b/docs/companies/supplier.md index 1e0985c..2c18b4a 100644 --- a/docs/companies/supplier.md +++ b/docs/companies/supplier.md @@ -4,7 +4,7 @@ title: Suppliers ## Suppliers -A supplier is an external vendor of parts and raw materials. +A supplier is an external **vendor** of parts and raw materials. To access the supplier page, click on the "Buy" navigation tab and click on "Suppliers" option in the dropdown list. From 5ba24e88fb00d1f15ac3f7ac75b1c7e6e980ef9f Mon Sep 17 00:00:00 2001 From: eeintech Date: Fri, 13 Nov 2020 15:55:11 -0500 Subject: [PATCH 3/4] Added permission warnings and edit/delete sections for supplier/manufacturer/customer --- docs/admin/permissions.md | 2 +- docs/companies/customer.md | 17 +++++++++++++---- docs/companies/manufacturer.md | 22 +++++++++++++++++++--- docs/companies/supplier.md | 22 +++++++++++++++++++--- 4 files changed, 52 insertions(+), 11 deletions(-) diff --git a/docs/admin/permissions.md b/docs/admin/permissions.md index c9c5afc..ba8c604 100644 --- a/docs/admin/permissions.md +++ b/docs/admin/permissions.md @@ -32,7 +32,7 @@ InvenTree functionality is split into a number of distinct roles. A group will h - **Purchase** - The *purchase* role is related to accessing Purchase Order data - **Sales** - The *sales* role is related to accessing Sales Order data -{% with id="roles", url="admin/roles.png", description="Roles" %} +{% with id="Roles Admin View", url="admin/roles.png", description="Roles" %} {% include 'img.html' %} {% endwith %} diff --git a/docs/companies/customer.md b/docs/companies/customer.md index 3bc46c2..8e10ac4 100644 --- a/docs/companies/customer.md +++ b/docs/companies/customer.md @@ -8,12 +8,21 @@ 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) + ### Add Customer -!!! missing "TODO" - This section requires further work +Once the customer page is loaded, click on the " New Customer" button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on the "Submit" button. ### Edit Customer -!!! missing "TODO" - This section requires further work +To edit a customer, click on its name in the list of customers. + +After the customer details are loaded, click on the icon under the customer name. Edit the customer information then click on the "Submit" button. + +### Delete Customer + +To delete a customer, click on its name in the list of customers. + +After the customer details are loaded, click on the icon under the customer name. Confirm the deletion using the checkbox then click on the "Submit" button. diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md index 55e39ce..ff2b682 100644 --- a/docs/companies/manufacturer.md +++ b/docs/companies/manufacturer.md @@ -8,22 +8,38 @@ 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) + ### Add Manufacturer -Once the manufacturer page is loaded, click on the "New Manufacturer" button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) and click on "Submit". +Once the manufacturer page is loaded, click on the " New Manufacturer" button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on the "Submit" button. !!! note "Manufacturer vs Supplier" In the case the manufacturer sells directly to customers, you may want to enable the checkbox `is supplier` before submitting the form (you can also enable it later on). Purchase orders rely exclusively on [supplier parts](../supplier#supplier-parts), therefore the manufacturer will need to be set as a supplier too. ### Edit Manufacturer -!!! missing "TODO" - This section requires further work +To edit a manufacturer, click on its name in the list of manufacturers. + +After the manufacturer details are loaded, click on the icon under the manufacturer name. Edit the manufacturer information then click on the "Submit" button. + +### Delete Manufacturer + +!!! warning + All manufacturer parts for this manufacturer will also be deleted! + +To delete a manufacturer, click on its name in the list of manufacturers. + +After the manufacturer details are loaded, click on the icon under the manufacturer name. Review the list of manufacturer parts to be deleted in consequence of deleting this manufacturer. Confirm the deletion using the checkbox then click on the "Submit" button. ## Manufacturer Parts Manufacturer parts are linked to a manufacturer and supplier part: they are the actual "items" sold by a supplier. +!!! warning + **Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../../admin/permissions) + ### Add Manufacturer Part !!! missing "TODO" diff --git a/docs/companies/supplier.md b/docs/companies/supplier.md index 2c18b4a..4635443 100644 --- a/docs/companies/supplier.md +++ b/docs/companies/supplier.md @@ -8,22 +8,38 @@ A supplier is an external **vendor** of parts and raw materials. To access the supplier page, 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) + ### Add Supplier -Once the supplier page is loaded, click on the "New Supplier" button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) and click on "Submit". +Once the supplier page is loaded, click on the " New Supplier" button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on the "Submit" button. !!! note "Supplier vs Manufacturer" In the case the supplier is a manufacturer who sells directly to customers, you may want to enable the checkbox `is manufacturer` before submitting the form (you can also enable it later on). ### Edit Supplier -!!! missing "TODO" - This section requires further work +To edit a supplier, click on its name in the list of suppliers. + +After the supplier details are loaded, click on the icon under the supplier name. Edit the supplier information then click on the "Submit" button. + +### Delete Supplier + +!!! warning + All supplier parts for this supplier will also be deleted! + +To delete a supplier, click on its name in the list of suppliers. + +After the supplier details are loaded, click on the icon under the supplier name. Review the list of supplier parts to be deleted in consequence of deleting this supplier. Confirm the deletion using the checkbox then click on the "Submit" button. ## Supplier Parts 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) + ### Add Supplier Part !!! missing "TODO" From b420fc0dbdfdc04633a9a22dbcf25bdd6384c63e Mon Sep 17 00:00:00 2001 From: eeintech Date: Fri, 13 Nov 2020 16:17:06 -0500 Subject: [PATCH 4/4] Completed companies doc (will update purchase and sales orders separately) --- docs/companies/manufacturer.md | 12 +++++++----- docs/companies/supplier.md | 21 +++++++++++++++++---- 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md index ff2b682..86008b2 100644 --- a/docs/companies/manufacturer.md +++ b/docs/companies/manufacturer.md @@ -35,17 +35,19 @@ After the manufacturer details are loaded, click on the New Supplier Part" button to load the "Create new Supplier Part" form. Fill out the form with the supplier part information then click on the "Submit" button. ### Edit Supplier Part -!!! missing "TODO" - This section requires further work +To edit a supplier part, first access the supplier part detail page with one of the following options: + +* either navigate to a Part detail page, click on the "Suppliers" tab then click on the corresponding "Supplier Part" row value +* or navigate to a Supplier detail page, click on the "Parts" tab then click on the corresponding "Supplier Part" row value. + +After the supplier part details are loaded, click on the icon next to the supplier part image. Edit the supplier part information then click on the "Submit" button. + +### Delete Supplier Part + +To delete a supplier part, first access the supplier part detail page like in the [Edit Supplier Part](#edit-supplier-part) section. + +After the supplier part details are loaded, click on the icon next to the supplier part image. Review the the information for the supplier part to be deleted, confirm the deletion using the checkbox then click on the "Submit" button.