inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-14 19:25:37 +00:00
Code Activity

Prettyfying the Companies doc

Browse Source
This commit is contained in:
eeintech
2021-08-20 16:00:24 -04:00
parent c86114e620
commit 51aaaaec1f
8 changed files with 73 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/companies/customer.md
View File

@ -6,23 +6,23 @@ title: 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.
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)
### 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.
Once the customer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Customer</span> button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
### 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.
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 <span class="badge inventree confirm">Submit</span>
### 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.
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 <span class="badge inventree confirm">Submit</span>

22
docs/companies/manufacturer.md
View File

@ -6,14 +6,14 @@ title: 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.
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)
### 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.
Once the manufacturer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Manufacturer</span> button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
!!! info "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.md#supplier-parts), therefore the manufacturer will need to be set as a supplier too.
@ -22,7 +22,7 @@ Once the manufacturer page is loaded, click on the "<span class='fas fa-plus-cir
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.
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 <span class="badge inventree confirm">Submit</span>
### Delete Manufacturer
@ -31,7 +31,7 @@ After the manufacturer details are loaded, click on the <span class='fas fa-edit
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.
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 <span class="badge inventree confirm">Submit</span>
## Manufacturer Parts
@ -44,22 +44,22 @@ Manufacturer parts are linked to a manufacturer and defined as manufacturable it
To create a manufacturer part, you have the following options:
* either navigate to a Part detail page then click on the "Manufacturers" tab
* or navigate to a Manufacturer detail page then click on the "Manufactured Parts" tab.
* either navigate to a Part detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab
* or navigate to a Manufacturer detail page then click on the <span class="badge inventree nav side"><span class='fas fa-industry'></span> Manufactured Parts</span> tab.
Whichever you pick, click on the "<span class='fas fa-plus-circle'></span> New Manufacturer Part" button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on the "Submit" button.
Whichever you pick, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Manufacturer Part</span> button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on <span class="badge inventree confirm">Submit</span>
### Edit Manufacturer Part
To edit a manufacturer part, first access the manufacturer part detail page with one of the following options:
* either navigate to a Part detail page, click on the "Manufacturers" tab then click on the "MPN" link
* or navigate to a Manufacturer detail page, click on the "Manufactured Parts" tab then click on the "MPN" link.
* either navigate to a Part detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab then, in the <span class="badge inventree nav main">Part Manufacturers</span> table, click on the _MPN_ link
* or navigate to a Manufacturer detail page, click on the <span class="badge inventree nav side"><span class='fas fa-industry'></span> Manufactured Parts</span> tab then click on the _MPN_ link.
After the manufacturer part details are loaded, click on the <span class='fas fa-edit'></span> icon next to the manufacturer part image. Edit the manufacturer part information then click on the "Submit" button.
After the manufacturer part details are loaded, click on the <span class='fas fa-edit'></span> icon next to the manufacturer part image. Edit the manufacturer part information then click on <span class="badge inventree confirm">Submit</span>
### Delete Manufacturer Part
To delete a manufacturer part, first access the manufacturer part detail page like in the [Edit Manufacturer Part](#edit-manufacturer-part) section.
After the manufacturer part details are loaded, click on the <span class='fas fa-trash-alt'></span> icon next to the manufacturer part image. Review the the information for the manufacturer part to be deleted, confirm the deletion using the checkbox then click on the "Submit" button.
After the manufacturer part details are loaded, click on the <span class='fas fa-trash-alt'></span> icon next to the manufacturer part image. Review the the information for the manufacturer part to be deleted, confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>

2
docs/companies/po.md
View File

@ -4,7 +4,7 @@ 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.
To access the purchase order 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-list'></span> Purchase Orders</span> option in the dropdown list.
!!! missing "TODO"
This section requires further work

2
docs/companies/so.md
View File

@ -4,7 +4,7 @@ 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.
To access the sales order 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-list'></span> Sales Orders</span> option in the dropdown list.
!!! missing "TODO"
This section requires further work

26
docs/companies/supplier.md
View File

@ -6,14 +6,14 @@ title: 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.
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)
### 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.
Once the supplier page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Supplier</span> button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
!!! info "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).
@ -22,7 +22,7 @@ Once the supplier page is loaded, click on the "<span class='fas fa-plus-circle'
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.
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 <span class="badge inventree confirm">Submit</span>
### Delete Supplier
@ -31,7 +31,7 @@ After the supplier details are loaded, click on the <span class='fas fa-edit'></
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.
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 <span class="badge inventree confirm">Submit</span>
## Supplier Parts
@ -44,24 +44,24 @@ Supplier parts are linked to a supplier and defined as purchasable items.
To create a supplier part, you have the following options:
1. navigate to a Part detail page then click on the "Suppliers" tab
0. navigate to a Supplier detail page then click on the "Supplied Parts" tab
0. navigate to a Manufacturer detail page then click on the "Supplied Parts" tab.
1. navigate to a Part detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab
0. navigate to a Supplier detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab
0. navigate to a Manufacturer detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> 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.
Whichever you pick, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Supplier Part</span> button to load the "Create new Supplier Part" form. Fill out the form with the supplier part information then click on <span class="badge inventree confirm">Submit</span>
### Edit Supplier Part
To edit a supplier part, first access the supplier part detail page with one of the following options:
1. navigate to a Part detail page, click on the "Suppliers" tab then click on the corresponding "Supplier Part" link
0. navigate to a Supplier detail page, click on the "Supplied Parts" tab then click on the corresponding "Supplier Part" link
0. navigate to a Manufacturer detail page, click on the "Supplied Parts" tab then click on the corresponding "Supplier Part" link.
1. navigate to a Part detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab then, in the <span class="badge inventree nav main">Part Suppliers</span> table, click on the corresponding _Supplier Part_ link
0. navigate to a Supplier detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab then click on the corresponding _Supplier Part_ link
0. navigate to a Manufacturer detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab then click on the corresponding _Supplier Part_ link.
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.
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 <span class="badge inventree confirm">Submit</span>
### 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.
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 <span class="badge inventree confirm">Submit</span>