Merge pull request #33 from eeintech/companies_doc

Companies Documentation

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 %}
 

docs/buy/supplier.md

@@ -1,15 +0,0 @@
----
-title: Suppliers
----
-
-## Suppliers
-
-A supplier is an external vendor of parts and raw materials.
-
-!!! missing "TODO"
-	This section requires further work
-
-## Supplier Parts
-
-!!! missing "TODO"
-	This section requires further work

docs/companies/customer.md

@@ -0,0 +1,28 @@
+---
+title: Customers
+---
+
+## Customers
+
+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
+
+Once the customer page is loaded, click on the "<span class='fas fa-plus-circle'></span> 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
+
+To edit a customer, click on its name in the list of customers.
+
+After the customer details are loaded, click on the <span class='fas fa-edit'></span> 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 <span class='fas fa-trash-alt'></span> icon under the customer name. Confirm the deletion using the checkbox then click on the "Submit" button.

docs/companies/manufacturer.md

@@ -0,0 +1,53 @@
+---
+title: Manufacturers
+---
+
+## Manufacturers
+
+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 "<span class='fas fa-plus-circle'></span> 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
+
+To edit a manufacturer, click on its name in the list of manufacturers.
+
+After the manufacturer details are loaded, click on the <span class='fas fa-edit'></span> 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 <span class='fas fa-trash-alt'></span> 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 connected to the manufacturer they belong to. Most importantly, they are **linked** to a supplier part. In other words, manufacturer parts do **not** exist without a corresponding supplier part and 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
+
+Adding a manufacturer part is the same process as [adding a supplier part](../supplier#add-supplier-part).
+
+### Edit Manufacturer Part
+
+Editing a manufacturer part is the same process as [editing a supplier part](../supplier#edit-supplier-part).
+
+### Delete Manufacturer Part
+
+Deleting a manufacturer part is the same process as [deleting a supplier part](../supplier#delete-supplier-part).

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
 

docs/companies/so.md

@@ -0,0 +1,15 @@
+---
+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
+
+## Line Items
+
+!!! missing "TODO"
+	This section requires further work

docs/companies/supplier.md

@@ -0,0 +1,64 @@
+---
+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.
+
+!!! 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 "<span class='fas fa-plus-circle'></span> 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
+
+To edit a supplier, click on its name in the list of suppliers.
+
+After the supplier details are loaded, click on the <span class='fas fa-edit'></span> 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 <span class='fas fa-trash-alt'></span> 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
+
+To create a supplier part, you have the following options:
+* either navigate to a Part detail page then click on the "Suppliers" tab
+* or navigate to a Supplier detail page then click on the "Parts" tab.
+
+Whichever you pick, click on the "<span class='fas fa-plus-circle'></span> 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
+
+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 <span class='fas fa-edit'></span> 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 <span class='fas fa-trash-alt'></span> 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.

mkdocs.yml

@@ -61,9 +61,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