inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2026-04-16 08:18:53 +00:00
Code Activity

Docs refactor (#9545)

Browse Source 
* Refactor / reognaize docs structure

* Refactor plugin docs structure

* More refactoring / cleanup

* Update build images

* Gallery updates

* Order images

* Update part docs

* Settings images

* Stock images

* Reitntroduce gallery

* Add custom icon macro

* Update icons

* Cleanup

* Fix link

* Fix internal links

* Revert some page moves

* Fix links

* Fix links
This commit is contained in:
Oliver
2025-04-22 08:18:32 +10:00
committed by GitHub
parent 9b489911e5
commit 6b08e45eac
240 changed files with 964 additions and 831 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/part/create.md
View File

@@ -9,7 +9,7 @@ New parts can be created from the *Part Category* view, by pressing the *New Par
!!! info "Permissions"
If the user does not have "create" permission for the *Part* permission group, the *New Part* button will not be available.
{% with id="new", url="part/new_part.png", descript="New Part" %}
{% with id="new", url="part/new_part.png", description="New Part" %}
{% include "img.html" %}
{% endwith %}
@@ -17,7 +17,7 @@ New parts can be created from the *Part Category* view, by pressing the *New Par
A part creation form is opened as shown below:
{% with id="newform", url="part/part_create_form.png", descript="New Part Form" %}
{% with id="newform", url="part/part_create_form.png", description="New Part Form" %}
{% include "img.html" %}
{% endwith %}
@@ -30,10 +30,6 @@ Once the form is completed, the browser window is redirected to the new part det
If the *Create Initial Stock* setting is enabled, then an extra section is available in the part creation form to create an initial quantity of stock for the newly created part:
{% with id="setting", url="part/create_initial_stock_option.png", description="Create stock option" %}
{% include "img.html" %}
{% endwith %}
If this setting is enabled, the following elements are available in the form:
{% with id="initial_stock", url="part/part_initial_stock.png", descript="Initial stock" %}
@@ -64,6 +60,6 @@ If the *Add Supplier Data* option is checked, then supplier part and manufacture
The following alternative methods for creating parts are supported:
- [Via the REST API](../api/api.md)
- [Using the Python library](../api/python/python.md)
- [Via the REST API](../api/index.md)
- [Using the Python library](../api/python/index.md)
- [Within the Admin interface](../settings/admin.md)

14
docs/docs/part/part.md → docs/docs/part/index.md
View File

@@ -41,11 +41,11 @@ A *Template* part is one which can have *variants* which exist underneath it. [R
### 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.md).
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](../manufacturing/bom.md).
### 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.md)
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](../manufacturing/bom.md)
### Testable
@@ -63,15 +63,15 @@ If a part is designated as *Purchaseable* it can be purchased from external supp
#### Suppliers
A [Supplier](../order/company.md#suppliers) is an external vendor who provides goods or services.
A [Supplier](../purchasing/supplier.md) is an external vendor who provides goods or services.
#### Supplier Parts
Purchaseable parts can be linked to [Supplier Parts](../order/company.md#supplier-parts). A supplier part represents an individual piece or unit that is procured from an external vendor.
Purchaseable parts can be linked to [Supplier Parts](../purchasing/supplier.md#supplier-parts). A supplier part represents an individual piece or unit that is procured from an external vendor.
#### Purchase Orders
A [Purchase Order](../order/purchase_order.md) allows parts to be ordered from an external supplier.
A [Purchase Order](../purchasing/purchase_order.md) allows parts to be ordered from an external supplier.
### Salable
@@ -106,7 +106,7 @@ It is possible to track parts using physical quantity values, such as *metres* o
### Supplier Part Units
By default, units of measure for [supplier parts](../order/company.md#supplier-parts) are specified in the same unit as their base part. However, supplier part units can be changed to any unit *which is compatible with the base unit*.
By default, units of measure for [supplier parts](../purchasing/supplier.md#supplier-parts) are specified in the same unit as their base part. However, supplier part units can be changed to any unit *which is compatible with the base unit*.
!!! info "Example: Supplier Part Units"
If the base part has a unit of `metres` then valid units for any supplier parts would include `feet`, `cm`, `inches` (etc)
@@ -147,7 +147,7 @@ In the web interface, part images can be uploaded directly from the [part view](
#### API
Image upload is supported via the [InvenTree API](../api/api.md), allowing images to be associated with parts programmatically. Further, this means that the [Python interface](../api/python/python.md) also supports image upload.
Image upload is supported via the [InvenTree API](../api/index.md), allowing images to be associated with parts programmatically. Further, this means that the [Python interface](../api/python/index.md) also supports image upload.
#### Mobile App

16
docs/docs/part/notification.md
View File

@@ -32,14 +32,6 @@ All past notification are listed in the history. They can be deleted one-by-one
{% include 'img.html' %}
{% endwith %}
## Subscription List
Users can view the parts and categories they are subscribed to on the InvenTree home page:
{% with id="cat_subs", url="part/cat_subs.png", description="Category subscription list" %}
{% include 'img.html' %}
{% endwith %}
## Part Notification Events
### Low Stock Notification
@@ -50,7 +42,7 @@ Any users who are subscribed to notifications for the part in question will rece
### Build Order Notification
When a new [Build Order](../build/build.md) is created, the InvenTree software checks to see if any of the parts required to complete the order are low on stock.
When a new [Build Order](../manufacturing/build.md) is created, the InvenTree software checks to see if any of the parts required to complete the order are low on stock.
If there are any parts with low stock, a notification is generated for any users subscribed to notifications for the part being built.
@@ -88,8 +80,4 @@ When subscribed to a *Part Category*, a user will receive notifications when par
- Any parts contained in the category
- Any parts contained in the lower level categories
Subscribing to a part category operates in the same manner as for a part - simply click on the notification icon:
{% with id="cat_sub", url="part/category_notification.png", description="Subscribe to part category" %}
{% include 'img.html' %}
{% endwith %}
Subscribing to a part category operates in the same manner as for a part - simply click on the notification icon.

2
docs/docs/part/parameter.md
View File

@@ -60,7 +60,7 @@ Select the parameter `Template` you would like to use for this parameter, fill-o
## Parametric Tables
Parametric tables gather all parameters from all parts inside a particular [part category](./part.md#part-category) to be sorted and filtered.
Parametric tables gather all parameters from all parts inside a particular [part category](./index.md#part-category) to be sorted and filtered.
To access a category's parametric table, click on the "Parameters" tab within the category view:

18
docs/docs/part/pricing.md
View File

@@ -11,10 +11,10 @@ Pricing information can be determined from multiple sources:
| Pricing Source | Description | Linked to |
| --- | --- | ---|
| Internal Price | How much a part costs to make | [Part](../part/part.md) |
| Supplier Price | The price to theoretically purchase a part from a given supplier (with price-breaks) | [Supplier](../order/company.md#suppliers) |
| Purchase Cost | Historical cost information for parts purchased | [Purchase Order](../order/purchase_order.md) |
| BOM Price | Total price for an assembly (total price of all component items) | [Part](../part/part.md) |
| Internal Price | How much a part costs to make | [Part](../part/index.md) |
| Supplier Price | The price to theoretically purchase a part from a given supplier (with price-breaks) | [Supplier](../purchasing/supplier.md) |
| Purchase Cost | Historical cost information for parts purchased | [Purchase Order](../purchasing/purchase_order.md) |
| BOM Price | Total price for an assembly (total price of all component items) | [Part](../part/index.md) |
#### Override Pricing
@@ -26,8 +26,8 @@ Additionally, the following information is stored for each part, in relation to
| Pricing Source | Description | Linked to |
| --- | --- | --- |
| Sale Price | How much a salable item is sold for (with price-breaks) | [Part](../part/part.md) |
| Sale Cost | How much an item was sold for | [Sales Order](../order/sales_order.md) |
| Sale Price | How much a salable item is sold for (with price-breaks) | [Part](../part/index.md) |
| Sale Cost | How much an item was sold for | [Sales Order](../sales/sales_order.md) |
## Pricing Tab
@@ -75,7 +75,7 @@ If the **Internal Price Override** setting is enabled, then internal pricing dat
### Purchase History
If the Part is designated as *purchaseable*, then historical purchase cost information is displayed (and used to calculate overall pricing). Purchase history data is collected from *completed* [purchase orders](../order/purchase_order.md).
If the Part is designated as *purchaseable*, then historical purchase cost information is displayed (and used to calculate overall pricing). Purchase history data is collected from *completed* [purchase orders](../purchasing/purchase_order.md).
{% with id="pricing_purchase_history", url="part/pricing_purchase_history.png", description="Purchase History" %}
{% include 'img.html' %}
@@ -91,7 +91,7 @@ If supplier pricing information is available, this can be also used to determine
### BOM Pricing
If a Part is designated as an *assembly*, then the [Bill of Materials](../build/bom.md) (BOM) can be used to determine the price of the assembly. The price of each component in the BOM is used to calculate the overall price of the assembly.
If a Part is designated as an *assembly*, then the [Bill of Materials](../manufacturing/bom.md) (BOM) can be used to determine the price of the assembly. The price of each component in the BOM is used to calculate the overall price of the assembly.
{% with id="pricing_bom", url="part/pricing_bom.png", description="BOM Pricing" %}
{% include 'img.html' %}
@@ -122,7 +122,7 @@ If the Part is designated as *Salable* then sale price breaks are made available
### Sale History
If the Part is designated as *Salable* then historical sale cost information is available. Sale history data is collected from *completed* [sales orders](../order/sales_order.md).
If the Part is designated as *Salable* then historical sale cost information is available. Sale history data is collected from *completed* [sales orders](../sales/sales_order.md).
{% with id="pricing_sale_history", url="part/pricing_sale_history.png", description="Sale History" %}
{% include 'img.html' %}

12
docs/docs/part/stocktake.md
View File

@@ -9,8 +9,8 @@ A *Stocktake* refers to a "snapshot" of stock levels for a particular part, at a
In particular, an individual *Stocktake* record tracks the following information:
- The date of the Stocktake event
- A reference to the [part](./part.md) which is being counted
- The total number of individual [stock items](../stock/stock.md) available
- A reference to the [part](./index.md) which is being counted
- The total number of individual [stock items](../stock/index.md) available
- The total stock quantity of available stock
- The total cost of stock on hand
@@ -107,9 +107,9 @@ When performing a stocktake, various options are presented to the user:
| Option | Description |
| --- | --- |
| Part | Limit stocktake context to a part. If the selected part is a [template part](./part.md#template), any variant parts will also be included in the stocktake |
| Category | Limit stocktake context to a single [part category](./part.md#part-category). Parts which exist in child categories (under the selected parent category) will also be included. |
| Location | Limit stocktake context to a single [stock location](../stock/stock.md#stock-location). Any parts which have stock items contained in this location (or any child locations) will be included in the stocktake |
| Part | Limit stocktake context to a part. If the selected part is a [template part](./index.md#template), any variant parts will also be included in the stocktake |
| Category | Limit stocktake context to a single [part category](./index.md#part-category). Parts which exist in child categories (under the selected parent category) will also be included. |
| Location | Limit stocktake context to a single [stock location](../stock/index.md#stock-location). Any parts which have stock items contained in this location (or any child locations) will be included in the stocktake |
| Generate Report | Select this option to generate a [stocktake report](#stocktake-reports) for the selected parts. |
| Update Parts | Select this option to save a new stocktake record for each selected part. |
@@ -143,4 +143,4 @@ If enabled, stocktake reports can be generated automatically at a configured int
### API Functionality
Stocktake actions can also be performed via the [API](../api/api.md).
Stocktake actions can also be performed via the [API](../api/index.md).

11
docs/docs/part/template.md
View File

@@ -23,13 +23,10 @@ The template / variant relationship is subtly different to the category / part r
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 %}
1. Navigate to a specific part detail page
2. Click on the "Details" tab
3. Locate the part options on the right-hand side
4. Toggle the `Template` option so it shows green / slider to the right:
### Create Variant

2
docs/docs/part/test.md
View File

@@ -4,7 +4,7 @@ title: Part Test Templates
## Part Test Templates
Parts which are designated as [testable](./part.md#testable) can define templates for tests which are to be performed against individual stock items corresponding to the part.
Parts which are designated as [testable](./index.md#testable) 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.

6
docs/docs/part/trackable.md
View File

@@ -2,13 +2,13 @@
title: Trackable Parts
---
Denoting a part as *Trackble* changes the way that [stock items](../stock/stock.md) associated with the particular part are handled in the database. A trackable part also has more restrictions imposed by the database scheme.
Denoting a part as *Trackble* changes the way that [stock items](../stock/index.md) associated with the particular part are handled in the database. A trackable part also has more restrictions imposed by the database scheme.
## Stock Tracking
For many parts in an InvenTree database, simply tracking current stock levels (and locations) is sufficient. However, some parts require more extensive tracking than simple stock level knowledge.
Any stock item associated with a trackable part *must* have either a batch number or a serial number. This includes stock created manually or via an internal process (such as a [Purchase Order](../order/purchase_order.md) or a [Build Order](../build/build.md)).
Any stock item associated with a trackable part *must* have either a batch number or a serial number. This includes stock created manually or via an internal process (such as a [Purchase Order](../purchasing/purchase_order.md) or a [Build Order](../manufacturing/build.md)).
## Assign Serial Numbers
@@ -35,4 +35,4 @@ For example:
## Build Orders
[Build orders](../build/build.md) have some extra requirements when either building a trackable part, or using parts in the Bill of Materials which are themselves trackable.
[Build orders](../manufacturing/build.md) have some extra requirements when either building a trackable part, or using parts in the Bill of Materials which are themselves trackable.

24
docs/docs/part/views.md
View File

@@ -4,22 +4,12 @@ title: Part Views
## Part Views
The main part view is divided into 4 different panels:
The Part detail view page provides a detailed view of a single part in the system. The page is divided into several sections, which are described in this document.
1. Categories
2. Details
3. Tabs
4. Content of each tab
{% with id="part_view_intro", url="part/part_view_intro.png", description="Part View Introduction" %}
{% include 'img.html' %}
{% endwith %}
<p></p>
## Categories
### Category Breadcrumb List
The categories of each part is displayed on the top navigation bar as show in the above screenshot.
[Click here](./part.md#part-category) for more information about categories.
[Click here](./index.md#part-category) for more information about categories.
## Part Details
@@ -93,7 +83,7 @@ The *Allocated* tab displays how many units of this part have been allocated to
### Bill of Materials
The *BOM* tab displays the [Bill of Materials](../build/bom.md) - 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).
The *BOM* tab displays the [Bill of Materials](../manufacturing/bom.md) - 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
@@ -145,11 +135,7 @@ Related parts can be added and are shown under a table of the same name in the "
{% include 'img.html' %}
{% endwith %}
This feature can be enabled or disabled in the global part settings:
{% with id="related_parts_setting", url="part/part_related_setting.png", description="Related Parts Example View" %}
{% include 'img.html' %}
{% endwith %}
This feature can be enabled or disabled in the global part settings.
### Attachments