From 51aaaaec1f6608d7a876a625613aba3774ae6525 Mon Sep 17 00:00:00 2001 From: eeintech Date: Fri, 20 Aug 2021 16:00:24 -0400 Subject: [PATCH] Prettyfying the Companies doc --- docs/build/bom.md | 4 ++-- docs/companies/customer.md | 8 +++---- docs/companies/manufacturer.md | 22 +++++++++---------- docs/companies/po.md | 2 +- docs/companies/so.md | 2 +- docs/companies/supplier.md | 26 +++++++++++----------- docs/part/template.md | 2 +- docs/stylesheets/extra.css | 40 ++++++++++++++++++++++++++++++++++ 8 files changed, 73 insertions(+), 33 deletions(-) diff --git a/docs/build/bom.md b/docs/build/bom.md index c82bc42..73b8c66 100644 --- a/docs/build/bom.md +++ b/docs/build/bom.md @@ -85,7 +85,7 @@ The `Create BOM Item` form will be displayed: {% include 'img.html' %} {% endwith %} -Fill-out the `Quantity` (required), `Reference`, `Overage` and `Note` (optional) fields then click on the "Submit" button to add the BOM item to this part's BOM. +Fill-out the `Quantity` (required), `Reference`, `Overage` and `Note` (optional) fields then click on Submit to add the BOM item to this part's BOM. ### Upload BOM @@ -145,7 +145,7 @@ After [adding BOM items manually](#add-bom-item) or [uploading a BOM file](#uplo The first message in the red box `The BOM for PCBA TEST has changed, and must be validated.` points out that InvenTree BOM needs to be "validated". BOM validation is a way to ensure a BOM does not have duplicate items/parts. -To process with BOM validation, click on the icon and the `Validate BOM` form will be displayed. Click one the "Validate" switch then click on the "Submit" button. +To process with BOM validation, click on the icon and the `Validate BOM` form will be displayed. Click one the "Validate" switch then click on Submit Voilà, this Bill of Materials is validated diff --git a/docs/companies/customer.md b/docs/companies/customer.md index 818bcf1..8a72025 100644 --- a/docs/companies/customer.md +++ b/docs/companies/customer.md @@ -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 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) ### Add Customer -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. +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 Submit ### Edit Customer 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. +After the customer details are loaded, click on the icon under the customer name. Edit the customer information then click on Submit ### 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. +After the customer details are loaded, click on the icon under the customer name. Confirm the deletion using the checkbox then click on Submit diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md index 2979350..84aa909 100644 --- a/docs/companies/manufacturer.md +++ b/docs/companies/manufacturer.md @@ -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 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) ### 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) then click on the "Submit" button. +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 Submit !!! 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 " icon under the manufacturer name. Edit the manufacturer information then click on the "Submit" button. +After the manufacturer details are loaded, click on the icon under the manufacturer name. Edit the manufacturer information then click on Submit ### Delete Manufacturer @@ -31,7 +31,7 @@ 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. +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 Submit ## 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 Suppliers tab +* or navigate to a Manufacturer detail page then click on the Manufactured Parts tab. -Whichever you pick, click on the " 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 New Manufacturer Part button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on Submit ### 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 Suppliers tab then, in the Part Manufacturers table, click on the _MPN_ link +* or navigate to a Manufacturer detail page, click on the Manufactured Parts tab then click on the _MPN_ link. -After the manufacturer part details are loaded, click on the 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 icon next to the manufacturer part image. Edit the manufacturer part information then click on Submit ### 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 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 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 Submit diff --git a/docs/companies/po.md b/docs/companies/po.md index e1141e9..f839ae6 100644 --- a/docs/companies/po.md +++ b/docs/companies/po.md @@ -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 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 632980f..f34527e 100644 --- a/docs/companies/so.md +++ b/docs/companies/so.md @@ -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 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 1111f92..da2921b 100644 --- a/docs/companies/supplier.md +++ b/docs/companies/supplier.md @@ -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 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) ### 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) then click on the "Submit" button. +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 Submit !!! 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 " icon under the supplier name. Edit the supplier information then click on the "Submit" button. +After the supplier details are loaded, click on the icon under the supplier name. Edit the supplier information then click on Submit ### Delete Supplier @@ -31,7 +31,7 @@ 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. +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 Submit ## 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 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. -Whichever you pick, 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. +Whichever you pick, 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 Submit ### 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 Suppliers tab then, in the Part Suppliers table, 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. -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. +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 Submit ### 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. +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 Submit diff --git a/docs/part/template.md b/docs/part/template.md index 407f406..33ba0d4 100644 --- a/docs/part/template.md +++ b/docs/part/template.md @@ -41,4 +41,4 @@ The `Create Variant` form will be displayed: {% include 'img.html' %} {% endwith %} -Fill-out the form then click on the "Submit" button to create the variant. \ No newline at end of file +Fill-out the form then click on Submit to create the variant. \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 79abcff..c5a69b8 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -68,6 +68,10 @@ p { text-align: justify; } +div:nth-of-type(1) p { + padding-top: 12px; +} + /* Remove page title */ .md-content h1:first-child { display: none; @@ -88,4 +92,40 @@ p { .blue { color: #55C; +} + +.badge.inventree { + font-family: "Helvetica Neue",Helvetica,Arial,sans-serif; + font-size: 14px; + font-weight: 400; + border-radius: 5px; + padding: 6px 12px; + border-style: solid; + border-width: 1px; +} + +.badge.inventree.nav.main { + background-color: #e7e7e7; + color: #777; + border-width: 0px; +} + +.badge.inventree.nav.side { + background-color: #fff; + color: #337ab7; + border-color: #ddd; + font-size: 100%; + font-weight: 500; +} + +.badge.inventree.add { + background-color: #449d44; + border-color: #398439; + color: #fff; +} + +.badge.inventree.confirm { + background-color: #337ab7; + border-color: #2e6da4; + color: #fff; } \ No newline at end of file