diff --git a/docs/assets/images/part/create_parameter_template.png b/docs/assets/images/part/create_parameter_template.png new file mode 100644 index 0000000..83f1f72 Binary files /dev/null and b/docs/assets/images/part/create_parameter_template.png differ diff --git a/docs/assets/images/part/create_part_parameter.png b/docs/assets/images/part/create_part_parameter.png new file mode 100644 index 0000000..9201ac8 Binary files /dev/null and b/docs/assets/images/part/create_part_parameter.png differ diff --git a/docs/assets/images/part/create_part_variant.png b/docs/assets/images/part/create_part_variant.png new file mode 100644 index 0000000..174b0ae Binary files /dev/null and b/docs/assets/images/part/create_part_variant.png differ diff --git a/docs/assets/images/part/enable_template_part.png b/docs/assets/images/part/enable_template_part.png new file mode 100644 index 0000000..d09ef52 Binary files /dev/null and b/docs/assets/images/part/enable_template_part.png differ diff --git a/docs/assets/images/part/part_parameters_example.png b/docs/assets/images/part/part_parameters_example.png new file mode 100644 index 0000000..d8a885f Binary files /dev/null and b/docs/assets/images/part/part_parameters_example.png differ diff --git a/docs/contribute.md b/docs/contribute.md index de76a2f..8ce12aa 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -28,7 +28,7 @@ InvenTree provides a translation layer for the web interface, this requires effo ### Documentation -Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree.github.io). +Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree-docs). ### Donate diff --git a/docs/index.md b/docs/index.md index 3dbb304..40b12c1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,19 +14,19 @@ InvenTree is designed to be lightweight and easy to use for SME or hobbyist appl InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API. -InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight sqlite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users. +InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight SQLite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users. ## Features ### Organize Parts -Parts are the fundemental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs. +Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs. [Read more...](part/part) ### Manage Suppliers -Link parts to multiple suppliers, +InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory. [Read more...](buy/supplier) @@ -39,12 +39,14 @@ Instantly view current stock for a certain part, in a particular location, or re ### BOM Management Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part. +InvenTree allows you to upload simple BOM files in multiple formats, and download a detailed BOM with all the information stored in its database. [Read more...](build/bom) ### Build Parts -Consume stock items to make new parts +Inventree features a build management system to help you track the progress of your builds. +Builds consume stock items to make new parts, you can decide to automatically or manually allocate parts from your current inventory. [Read more...](build/build) diff --git a/docs/part/parameter.md b/docs/part/parameter.md index 4e91ef0..9d10f7b 100644 --- a/docs/part/parameter.md +++ b/docs/part/parameter.md @@ -5,5 +5,43 @@ layout: page ## Part Parameters -!!! missing "TODO" - Parameter documentation to be written +Part parameters are located in the "Parameters" tab, on each part detail page. +There is no limit for the number of part parameters and they are fully customizable through the use of parameters templates. + +Here is an example of parameters for a Ceramic capacitor: +{% with id="part_parameters_example", url="part/part_parameters_example.png", description="Part Parameters Example List" %} +{% include 'img.html' %} +{% endwith %} + +### Create Template + +A *Parameter Template* is required for each part parameter. + +To create a template, you have two options: + +1. navigate to the "Settings" page, click on the "Part" tab and then click on the "New Parameter" button +0. navigate to a specific part detail page, click on the "Parameters" tab, click on the "New Parameters" button then click on the "New Template" button in the newly displayed form. + +The `Create Part Parameter Template` form will be displayed: +{% with id="create_parameter_template", url="part/create_parameter_template.png", description="Create Part Parameter Template Form" %} +{% include 'img.html' %} +{% endwith %} + +Fill-out the template `Name` (required) and `Units` (optional) fields then click the "Submit" button. + +### Create Parameter + +After [creating a template](#create-template) or using the existing templates, you can add parameters to any part. + +To add a parameter, navigate to a specific part detail page, click on the "Parameters" tab then click on the "New Parameters" button, the `Create Part Parameter` form will be displayed: + +{% with id="create_part_parameter", url="part/create_part_parameter.png", description="Create Part Parameter Form" %} +{% include 'img.html' %} +{% endwith %} + +Select the parameter `Template` you would like to use for this parameter, fill-out the `Data` field (value of this specific parameter) and click the "Submit" button. + +### Parametric Tables + +!!! note "Future Feature Proposal" + Allow parts to be filtered using parameters. Narrow down the list of parameters to the parts found in each category. diff --git a/docs/part/template.html b/docs/part/template.html new file mode 100644 index 0000000..d50faea --- /dev/null +++ b/docs/part/template.html @@ -0,0 +1,1075 @@ +Part Templates

Part Templates

+

There are various purposes for using part templates, among them: +* template parts can hold information that can be re-used across “variants”, a template part could be useful for creating a base variant of an assembly which can be derived from, with BoM changes for instance +*

+

“Variants” parts will reference the “Template” part therefore explicitly creating and showing direct relationship. +They also allow you to do special things like: +* Serial Numbers +Parts that are linked in a template / variant relationship must have unique serial numbers. e.g. if you have a template part Widget, and two variants Widget-01 and Widget-02 then any assigned serial numbers must be unique across all these variants.

+

Stock Reporting +The “stock” for a template part includes stock for all variants under that part

+

Logical Grouping +The template / variant relationship is subtly different to the category / part relationship

+

Create Variant

+

When a part’s Template option is turned-on, “Variants” of this part can be created.

+

To create a variant, navigate to a specific part detail page, click on the “Variants” tab then click on the “New Variant” button. +The Create Variant form will be displayed: +{% with id=”create_part_variant”, url=”part/create_part_variant.png”, description=”Create Part Variant Form” %} +{% include ‘img.html’ %}

\ No newline at end of file diff --git a/docs/part/template.md b/docs/part/template.md index 0b99458..4dfaca8 100644 --- a/docs/part/template.md +++ b/docs/part/template.md @@ -5,5 +5,41 @@ layout: page ## Part Templates -!!! missing "TODO" - Parameter documentation to be written +There are various purposes for using Part Templates, among them: + +* Template parts can hold information that can be re-used across "Variants", a template part could be useful for creating a base variant of an assembly which can be derived from, with BoM changes for instance. +* Variants can be used as "manufacturing variants" where the variant dictates a particular configuration which a customer can order: a variant might determine the particular options that come with a part, like harnesses, enclosure, color, specs, etc. + +"Variants" parts will reference the "Template" part therefore explicitly creating and showing direct relationship. +They also allow you to do special things like: + +* **Serial Numbers** +Parts that are linked in a template / variant relationship must have unique serial numbers (e.g. if you have a template part Widget, and two variants Widget-01 and Widget-02 then any assigned serial numbers must be unique across all these variants). +* **Stock Reporting** +The "stock" for a template part includes stock for all variants under that part. +* **Logical Grouping** +The template / variant relationship is subtly different to the category / part relationship. + +### Enable Template Part + +Any part can be set as "Template" part. To do so: + +1. navigate to a specific part detail page +0. click on the "Details" tab +0. locate the part options on the right-hand side +0. toggle the `Template` option so it shows green / slider to the right: +{% with id="enable_template_part", url="part/enable_template_part.png", description="Enable Template Part Option" %} +{% include 'img.html' %} +{% endwith %} + +### Create Variant + +When a part's [*Template option*](#enable-template-part) is turned-on, "Variants" of this part can be created. + +To create a variant, navigate to a specific part detail page, click on the "Variants" tab then click on the "New Variant" button. +The `Create Variant` form will be displayed: +{% with id="create_part_variant", url="part/create_part_variant.png", description="Create Part Variant Form" %} +{% include 'img.html' %} +{% endwith %} + +Fill-out the form then click on the "Submit" button to create the variant. \ No newline at end of file diff --git a/docs/part/views.md b/docs/part/views.md index e8212d5..cf10b7f 100644 --- a/docs/part/views.md +++ b/docs/part/views.md @@ -57,7 +57,9 @@ Parts can have multiple defined [parameters](/part/parameter). ## Variants -If a part is a *Template Part* then the *Variants* tab will be visible. [Part templates](/part/template) +If a part is a *Template Part* then the *Variants* tab will be visible. + +[Read about Part templates](/part/template) ## Stock @@ -93,8 +95,7 @@ The *BOM* tab displays the [Bill of Materials](/build/bom) - a list of sub-compo ## Build Orders -!!! missing "TODO" - Documentation to be written +The *Build Orders* tab shows a list of the builds for this part. It provides a view for important build information like quantity, status, creation and completion dates. ## Used In @@ -118,8 +119,7 @@ This tab is only displayed if the part is marked as *Purchaseable*. ## Sales Orders -!!! missing "TODO" - Documentation to be written +The *Sales Orders* tab shows a list of the sales orders for this part. It provides a view for important sales order information like customer, status, creation and shipment dates. ## Tests