Initial commit

- Copied from inventree.github.io

docs/part/parameter.md

@@ -0,0 +1,9 @@
+---
+title: Part Parameters
+layout: page
+--- 
+
+## Part Parameters
+
+!!! missing "TODO"
+	Parameter documentation to be written

docs/part/part.md

@@ -0,0 +1,30 @@
+---
+title: Parts
+layout: page
+---
+
+# Part
+
+The *Part* is the core element of the InvenTree ecosystem. A Part object is the archetype of any stock item in your inventory. Parts are arranged in heirarchical categories which are used to organise and filter parts by function.
+
+## Part Category 
+
+Part categories are very flexible and can be easily arranged to match a particular user requirement. Each part category displays a list of all parts *under* that given category. This means that any part belonging to a particular category, or belonging to a sub-category, will be displayed.
+
+Each part category also shows a list of sub-categories which exist underneath it.
+
+{% with id="part_category", url="part/part_category.png", description="Parts are arranged in categories" %}
+{% include 'img.html' %}
+{% endwith %}
+
+The category part list provides an overview of each part:
+
+* Part name and description
+* Part image thumbnail
+* Part category
+* Part stock level
+
+The list of parts underneath a given category can be filtered by multiple user-configurable filters, which is especially useful when a large number of parts exist under a certain category.
+
+Clicking on the part name links to the [*Part Detail*](/part/views) view.
+

docs/part/template.md

@@ -0,0 +1,9 @@
+---
+title: Part Templates
+layout: page
+---
+
+## Part Templates
+
+!!! missing "TODO"
+	Parameter documentation to be written

docs/part/test.md

@@ -0,0 +1,43 @@
+---
+title: Part Test Templates
+layout: page
+---
+
+## Part Test Templates
+
+Parts which are designated as *trackable* (meaning they can be uniquely serialized) can define templates for tests which are to be performed against individual stock items corresponding to the part.
+
+A test template defines the parameters of the test; the individual stock items can then have associated test results which correspond to a test template.
+
+Test templates "cascade" down to variant parts: this means that if a master part has multiple variants, any test template defined for the master part will be assigned to the variants. Any stock items of the variant parts will have the same test templates associated with them.
+
+!!! missing "TODO"
+	Include pictures of the Test Template tab
+
+### Test Template Parameters
+
+#### Test Name
+
+The name of the test is a simple string value which defines the name of the test. This test must be unique for a given part (or across a set of part variants). 
+
+The test name is used to generate a test "key" which is then used to match against test results associated with individual stock items.
+
+#### Test Description
+
+This field is a simple description for providing information back to the user. The description is not used by the InvenTree testing framework.
+
+#### Required
+
+If the *required* flag is set, this indicates that the test is crucial for the acceptance of a particular stock item.
+
+#### Requires Value
+
+If this flag is set, then a corresponding test result against a stock item must set the *value* parameter.
+
+#### Requires Attachment
+
+If this flag is set, then a corresponding test result against a stock item must provide a file attachment uploaded.
+
+### Test Results
+
+Individual stock item objects can have test results associated with them which correspond to test templates. Refer to the [stock test result](/stock/test) documentation for further information.

docs/part/views.md

@@ -0,0 +1,134 @@
+---
+title: Part Views
+layout: page
+---
+
+The Part information page organizes part data into sections, displayed as tabs.
+
+## Part Details
+
+The *Details* tab shows a detail view which provides information about the particular part.
+
+{% with id="part_overview", url="part/part_overview.png", description="Part details" %}
+{% include 'img.html' %}
+{% endwith %}
+
+A Part is defined in the system by the following parameters:
+
+### Part Definition Fields
+
+**Part Name** - The Part name is a simple (unique) text label
+
+**Description** - Longer form text field describing the Part
+
+**Internal Part Number (IPN)** - A special code which can be used to link a part to a numbering system. The IPN field is not required, but may be useful where a part numbering system has been defined.
+
+**Revision** - An optional revision code denoting the particular version for the part. Used when there are multiple revisions of the same master part object.
+
+**Category** - The Part category is used to group or arrange parts, as per the particular requirements of the user. Categories are arranged in a 'tree' where each category may have multiple child categories.
+
+**External Link** - An external URL field is provided to link to an external page. This could be useful the part has extra documentation located on an external server.
+
+**Units** - Units of measure (UoM) for this Part. The default is 'pcs'
+
+### Part Options
+
+A Part can provide different functionality based on the following options.
+
+**Virtual** - A *Virtual* part is one which does not physically exist but should still be tracked in the system. This could be a process step, machine time, software license, etc.
+
+**Template** - A *Template* part is one which can have *variants* which exist underneath it. [Read further information about template parts here](/part/template).
+
+**Assembly** - If a part is designated as an *Assembly* it can be created (or built) from other component parts. As an example, a circuit board assembly is made using multiple electronic components, which are tracked in the system. An *Assembly* Part has a Bill of Materials (BOM) which lists all the required sub-components. [Read further information about BOM management here](/build/bom).
+
+**Component** - If a part is designated as a *Component* it can be used as a sub-component of an *Assembly*. [Read further information about BOM management here](/build/bom)
+
+**Trackable** - If a part is designed as *trackable*, it can be tracked using unique serial numbers.
+
+**Purchaseable** - If a part is designated as *Purchaseable* it can be purchased from external suppliers. Setting this flag allows parts to be added to [purchase orders](/buy/po).
+
+**Salable** - If a part is designated as *Salable* it can be sold to external customers. Setting this flag allows parts to be added to sales orders.
+
+**Active** - By default, all parts are *Active*. Marking a part as inactive means it is not available for many actions, but the part remains in the database. If a part becomes obsolete, it is recommended that it is marked as inactive, rather than deleting it from the database.
+
+## Parameters
+
+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)
+
+## Stock
+
+The *Stock* tab shows all the stock items for the selected *Part*. The user can quickly determine how many parts are in stock, where they are located, and the status of each *Stock Item*.
+
+{% with id="part_stock", url="part/part_stock.png", description="Part Stock" %}
+{% include 'img.html' %}
+{% endwith %}
+
+### Functions
+
+The following functions are available from the *Part Stock* view.
+
+#### Export
+
+Exports the stocktake data for the selected Part. Launches a dialog to select export options, and then downloads a file containing data for all stock items for this Part.
+
+#### New Stock Item
+
+Launches a dialog to create a new *Stock Item* for the selected *Part*.
+
+#### Stock Actions
+
+If stock items are selected in the table, stock actions are enabled via the drop-down menu.
+
+## Allocations
+
+The *Allocated* tab displays how many units of this part have been allocated to pending build orders and/or sales orders. This tab is only visible if the Part is a *component* (meaning it can be used to make assemblies), or it is *salable* (meaning it can be sold to customers).
+
+## BOM
+
+The *BOM* tab displays the [Bill of Materials](/build/bom) - a list of sub-components used to build an assembly. Each row in the BOM specifies a quantity of another Part which is required to build the assembly. This tab is only visible if the Part is an *assembly* (meaning it can be build from other parts).
+
+## Build Orders
+
+!!! missing "TODO"
+	Documentation to be written
+
+## Used In
+
+The *Used In* tab displays a list of other parts that this part is used to make. This tab is only visible if the Part is a *component*.
+
+## Suppliers
+
+The *Suppliers* tab displays all the *Supplier Parts* for the selected *Part*. 
+
+This tab is only visible if the *Part* is designated as *Purchaseable*.
+
+{% with id="part_suppliers", url="part/part_suppliers.png", description="Part Suppliers" %}
+{% include 'img.html' %}
+{% endwith %}
+
+## Purchase Orders
+
+The *Part Purchase Orders* tab lists all the Purchase Orders against the selected part.
+
+This tab is only displayed if the part is marked as *Purchaseable*.
+
+## Sales Orders
+
+!!! missing "TODO"
+	Documentation to be written
+
+## Tests
+
+If a part is marked as *trackable*, the user can define tests which must be performed on any stock items which are instances of this part. [Read more about testing](/part/test).
+
+## Attachments
+
+The *Part Attachments* tab displays file attachments associated with the selected *Part*. Multiple file attachements (such as datasheets) can be uploaded for each *Part*.
+
+## Notes
+
+A part may have notes attached, which support markdown formatting.