mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-04-27 21:26:43 +00:00
Fixing pretty much every existing internal link.
Sometimes, it pays to RTFD
This commit is contained in:
Oliver Walters
parent
5de7189e5c
commit
b072165f75
@ -44,10 +44,12 @@ Refer to the [reference documentation](https://squidfunk.github.io/mkdocs-materi
|
||||
|
||||
Links to internal documentation pages **must** use relative pathing, otherwise the link will be broken by the readthedocs URL formatting.
|
||||
|
||||
Also, linking to an internal page must use the `.md` suffix!
|
||||
|
||||
For example, to link to the page `/part/views` from `/stock/stocktake`, the link must be formed as follows:
|
||||
|
||||
```
|
||||
Click [here](../../part/views)
|
||||
Click [here](../part/views.md)
|
||||
```
|
||||
|
||||
*Formatting the link as follows:*
|
||||
|
||||
@ -9,7 +9,7 @@ Users which have *staff* privileges have access to an Admin interface which prov
|
||||
!!! warning "Caution"
|
||||
Admin users should exercise extreme care when modifying data via the admin interface, as performing the wrong action may have unintended consequences!
|
||||
|
||||
The admin interface allows *staff* users the ability to directly view / add / edit / delete database entries according to their [user permissions](../permissions).
|
||||
The admin interface allows *staff* users the ability to directly view / add / edit / delete database entries according to their [user permissions](./permissions.md).
|
||||
|
||||
### Access Admin Interface
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ title: Email Configured
|
||||
|
||||
InvenTree can be configured to send emails to users, for various purposes.
|
||||
|
||||
To enable this, email configuration settings must be supplied to the InvenTree [configuration options](../../start/config#email-settings).
|
||||
To enable this, email configuration settings must be supplied to the InvenTree [configuration options](../start/config.md#email-settings).
|
||||
|
||||
!!! info "Password Reset"
|
||||
The *Password Reset* functionality requires the email backend to be correctly configured.
|
||||
|
||||
@ -31,7 +31,7 @@ Select the data file to import, and the data format. Press the "Submit" button t
|
||||
|
||||
### File Format
|
||||
|
||||
The uploaded data file must meet a number of formatting requirements for successful data upload. A simple way of ensuring that the file format is correct is to first [export data](../export) for the model in question, and delete all data rows (not the header row) from the exported data file.
|
||||
The uploaded data file must meet a number of formatting requirements for successful data upload. A simple way of ensuring that the file format is correct is to first [export data](./export.md) for the model in question, and delete all data rows (not the header row) from the exported data file.
|
||||
|
||||
Then, the same file can be used as a template for uploading more data to the server.
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ title: InvenTree Mobile App
|
||||
|
||||
## InvenTree Mobile App
|
||||
|
||||
The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../../extend/api), the app provides immediate access to inventory data without requiring physical access to a computer.
|
||||
The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../extend/api.md), the app provides immediate access to inventory data without requiring physical access to a computer.
|
||||
|
||||
Native barcode support provides a multitude of context-sensitive stock control actions, allowing streamlined inventory management at your fingertips. The app has been optimized for speed, providing instant access to stock knowledge and handy on-site functionality.
|
||||
|
||||
@ -95,7 +95,7 @@ Select *InvenTree* to navigate to the [home screen](#home-screen).
|
||||
|
||||
### Scan Barcode
|
||||
|
||||
Select *Scan Barcode* to open the barcode scanner, and scan an InvenTree stock item or location to instantly jump to the relevent view. Refer to the [barcode documentation](./barcode) for more information.
|
||||
Select *Scan Barcode* to open the barcode scanner, and scan an InvenTree stock item or location to instantly jump to the relevent view. Refer to the [barcode documentation](./barcode.md) for more information.
|
||||
|
||||
### Search
|
||||
|
||||
@ -103,15 +103,15 @@ Select *Search* to open a global search screen.
|
||||
|
||||
### Parts
|
||||
|
||||
Select *Parts* to navigate to the [Parts](./parts) view.
|
||||
Select *Parts* to navigate to the [Parts](./part.md) view.
|
||||
|
||||
### Stock
|
||||
|
||||
Select *Stock* to navigate to the [Stock](./stock) view.
|
||||
Select *Stock* to navigate to the [Stock](./stock.md) view.
|
||||
|
||||
### Settings
|
||||
|
||||
Select *Settings* to navigate to the app [settings](./settings) menu.
|
||||
Select *Settings* to navigate to the app [settings](./settings.md) menu.
|
||||
|
||||
## Home Screen
|
||||
|
||||
|
||||
2
docs/build/allocate.md
vendored
2
docs/build/allocate.md
vendored
@ -31,7 +31,7 @@ Before continuing, it is important that the difference between *untracked* and *
|
||||
|
||||
#### BOM Considerations
|
||||
|
||||
A [Bill of Materials](../bom) to generate an assembly may consist of a mixture of *untracked* and *tracked* components. The build order process can facilitate this, as documentated in the sections below.
|
||||
A [Bill of Materials](./bom.md) to generate an assembly may consist of a mixture of *untracked* and *tracked* components. The build order process can facilitate this, as documentated in the sections below.
|
||||
|
||||
### Tracked Build Outputs
|
||||
|
||||
|
||||
4
docs/build/bom.md
vendored
4
docs/build/bom.md
vendored
@ -4,7 +4,7 @@ title: Bill of Materials
|
||||
|
||||
## Bill of Materials
|
||||
|
||||
A Bill of Materials (BOM) defines the list of component parts required to make an assembly, [create builds](../build) and allocate inventory.
|
||||
A Bill of Materials (BOM) defines the list of component parts required to make an assembly, [create builds](./build.md) and allocate inventory.
|
||||
|
||||
A part which can be built from other sub components is called an *Assembly*.
|
||||
|
||||
@ -30,7 +30,7 @@ A BOM for a particular assembly is comprised of a number (zero or more) of BOM "
|
||||
|
||||
### Inherited BOM Line Items
|
||||
|
||||
When using the InvenTree [template / variant](../../part/template) feature, it may be useful to make use of the *inheritance* capability of BOM Line Items.
|
||||
When using the InvenTree [template / variant](../part/template.md) feature, it may be useful to make use of the *inheritance* capability of BOM Line Items.
|
||||
|
||||
If a BOM Line Item is designed as *Inherited*, it will be automatically included in the BOM of any part which is a variant (or sub-variant) of the part for which the BOM Line Item is defined.
|
||||
|
||||
|
||||
6
docs/build/build.md
vendored
6
docs/build/build.md
vendored
@ -4,9 +4,9 @@ title: Build Orders
|
||||
|
||||
## Build Orders
|
||||
|
||||
A *Build Order* is used to create new stock by assembling component parts, according to a [Bill of Materials](../bom)(BOM).
|
||||
A *Build Order* is used to create new stock by assembling component parts, according to a [Bill of Materials](./bom.md)(BOM).
|
||||
|
||||
A BOM can be specified for any [Part](../../part/part) which is designated as an *Assembly*. The BOM consists of other Parts which are designated as *Components*.
|
||||
A BOM can be specified for any [Part](../part/part.md) which is designated as an *Assembly*. The BOM consists of other Parts which are designated as *Components*.
|
||||
|
||||
A *Build Order* uses the BOM to allocate stock items to the assembly process. As the *Build Order* is completed, the required stock quantities are subtracted from allocated stock items.
|
||||
|
||||
@ -80,7 +80,7 @@ Allocating stock to a build does not actually subtrack the stock from the databa
|
||||
!!! info "Part Allocation Information"
|
||||
Any part which has stock allocated to a build order will indicate this on the part information page.
|
||||
|
||||
For further information, refer to the [stock allocation documentation](../allocate).
|
||||
For further information, refer to the [stock allocation documentation](./allocate.md).
|
||||
|
||||
## Build Order Display
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ 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.
|
||||
|
||||
!!! warning
|
||||
**Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../../admin/permissions)
|
||||
**Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../admin/permissions.md)
|
||||
|
||||
### Add Customer
|
||||
|
||||
|
||||
@ -9,14 +9,14 @@ 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.
|
||||
|
||||
!!! warning
|
||||
**Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../../admin/permissions)
|
||||
**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.
|
||||
|
||||
!!! 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#supplier-parts), therefore the manufacturer will need to be set as a supplier too.
|
||||
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.
|
||||
|
||||
### Edit Manufacturer
|
||||
|
||||
@ -38,7 +38,7 @@ After the manufacturer details are loaded, click on the <span class='fas fa-tras
|
||||
Manufacturer parts are linked to a manufacturer and defined as manufacturable items.
|
||||
|
||||
!!! warning
|
||||
**Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../../admin/permissions)
|
||||
**Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
|
||||
|
||||
### Add Manufacturer Part
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ 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.
|
||||
|
||||
!!! warning
|
||||
**Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../../admin/permissions)
|
||||
**Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
|
||||
|
||||
### Add Supplier
|
||||
|
||||
@ -38,7 +38,7 @@ After the supplier details are loaded, click on the <span class='fas fa-trash-al
|
||||
Supplier parts are linked to a supplier and defined as purchasable items.
|
||||
|
||||
!!! warning
|
||||
**Viewing**, **adding**, **editing** and **deleting** supplier parts require the corresponding [Purchase Orders user permissions](../../admin/permissions)
|
||||
**Viewing**, **adding**, **editing** and **deleting** supplier parts require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
|
||||
|
||||
### Add Supplier Part
|
||||
|
||||
|
||||
@ -81,7 +81,7 @@ response = request.get('http://localhost:8080/api/part/', data=data, headers=hea
|
||||
|
||||
### User Roles
|
||||
|
||||
Users can only perform REST API actions which align with their assigned [role permissions](../../admin/permissions/#roles).
|
||||
Users can only perform REST API actions which align with their assigned [role permissions](../admin/permissions.md#roles).
|
||||
Once a user has *authenticated* via the API, a list of the available roles can be retrieved from:
|
||||
|
||||
`/api/user/roles/`
|
||||
|
||||
@ -48,4 +48,4 @@ invoke worker
|
||||
|
||||
!!! info "Supervisor"
|
||||
|
||||
A better option is to manage the background worker process using a process manager such as supervisor. Refer to the [production server guide](../start/production).
|
||||
A better option is to manage the background worker process using a process manager such as supervisor. Refer to the [production server guide](./start/production.md).
|
||||
|
||||
@ -6,40 +6,40 @@ title: Features
|
||||
|
||||
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)
|
||||
[Read more...](./part/part.md)
|
||||
|
||||
## Manage 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)
|
||||
[Read more...](./companies/supplier.md)
|
||||
|
||||
## Instant Stock Knowledge
|
||||
|
||||
Instantly view current stock for a certain part, in a particular location, or required for an individual build. Stock items are organized in cascading locations and sub-locations, allowing flexible inspection of stock under any location. Stock items can be serialized for tracking of individual items, and test results can be stored against a serialized stock item for the purpose of acceptance testing and commissioning.
|
||||
|
||||
[Read more...](./stock/stock)
|
||||
[Read more...](./stock/stock.md)
|
||||
|
||||
## 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)
|
||||
[Read more...](./build/bom.md)
|
||||
|
||||
## Build 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)
|
||||
[Read more...](./build/build.md)
|
||||
|
||||
## Report
|
||||
|
||||
Generate a wide range of reports using custom templates. [Read more...](./report/report)
|
||||
Generate a wide range of reports using custom templates. [Read more...](./report/report.md)
|
||||
|
||||
## Extend and Customize
|
||||
|
||||
InvenTree is designed to be highly extensible. If the core InvenTree functionality does not meet your particular need, InvenTree provides a RESTful API, a native Python library, and a powerful plugin system.
|
||||
|
||||
[Read more...](./extend/api)
|
||||
[Read more...](./extend/api.md)
|
||||
|
||||
@ -21,15 +21,15 @@ InvenTree is designed to allow for a flexible installation. You could run the In
|
||||
|
||||
## Features
|
||||
|
||||
Refer to the [features](./features) page for a rundown on the features that InvenTree provides out of the box.
|
||||
Refer to the [features](./features.md) page for a rundown on the features that InvenTree provides out of the box.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Refer to the [installation guide](./start/intro) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed.
|
||||
Refer to the [installation guide](./start/intro.md) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed.
|
||||
|
||||
## Get the App
|
||||
|
||||
InvenTree is supported by a [companion mobile app](./app/app) which is tightly integrated with the InvenTree database. Lightning fast stock control, in your pocket!
|
||||
InvenTree is supported by a [companion mobile app](./app/app.md) which is tightly integrated with the InvenTree database. Lightning fast stock control, in your pocket!
|
||||
|
||||
## Source Code
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ The category part list provides an overview of each part:
|
||||
|
||||
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*](../views) view.
|
||||
Clicking on the part name links to the [*Part Detail*](./views.md) view.
|
||||
|
||||
## Part Options
|
||||
|
||||
@ -37,25 +37,25 @@ A *Virtual* part is one which does not physically exist but should still be trac
|
||||
|
||||
### Template
|
||||
|
||||
A *Template* part is one which can have *variants* which exist underneath it. [Read further information about template parts here](../template).
|
||||
A *Template* part is one which can have *variants* which exist underneath it. [Read further information about template parts here](./template.md).
|
||||
|
||||
### 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).
|
||||
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).
|
||||
|
||||
### 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)
|
||||
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)
|
||||
|
||||
### Trackable
|
||||
|
||||
Trackable parts can be assigned batch numbers or serial numbers which uniquely identify a particular stock item. Trackable parts also provide other features (and restrictions) in the InvenTree ecosystem.
|
||||
|
||||
[Read further information about trackable parts here](../trackable).
|
||||
[Read further information about trackable parts here](./trackable.md).
|
||||
|
||||
### 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).
|
||||
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](../companies/po.md).
|
||||
|
||||
### Salable
|
||||
|
||||
|
||||
@ -39,4 +39,4 @@ If this flag is set, then a corresponding test result against a stock item must
|
||||
|
||||
### 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.
|
||||
Individual stock item objects can have test results associated with them which correspond to test templates. Refer to the [stock test result](../stock/test.md) documentation for further information.
|
||||
@ -8,7 +8,7 @@ Denoting a part as *Trackble* changes the way that [stock items](../../stock/sto
|
||||
|
||||
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](../../buy/po) or a [Build Order](/../../build/build)).
|
||||
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](../companies/po.md) or a [Build Order](../build/build.md)).
|
||||
|
||||
|
||||
## Assign Serial Numbers
|
||||
|
||||
@ -32,13 +32,13 @@ A Part is defined in the system by the following parameters:
|
||||
|
||||
## Parameters
|
||||
|
||||
Parts can have multiple defined [parameters](../parameter).
|
||||
Parts can have multiple defined [parameters](./parameter.md).
|
||||
|
||||
## Variants
|
||||
|
||||
If a part is a *Template Part* then the *Variants* tab will be visible.
|
||||
|
||||
[Read about Part templates](../template)
|
||||
[Read about Part templates](./template.md)
|
||||
|
||||
## Stock
|
||||
|
||||
@ -70,7 +70,7 @@ The *Allocated* tab displays how many units of this part have been allocated to
|
||||
|
||||
## 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).
|
||||
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).
|
||||
|
||||
## Build Orders
|
||||
|
||||
@ -102,7 +102,7 @@ The *Sales Orders* tab shows a list of the sales orders for this part. It provid
|
||||
|
||||
## 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](../test).
|
||||
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](./test.md).
|
||||
|
||||
## Attachments
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ title: Release 0.1.5
|
||||
|
||||
[#1168](https://github.com/inventree/InvenTree/pull/1168) introduces the concept of *Target Date* for a Build Order. This is the intended completion date for the build. If the date is reached but the build is not yet complete, the build is consider *overdue*.
|
||||
|
||||
Refer to the [build documentation](../../build/build/#overdue-builds) for more information.
|
||||
Refer to the [build documentation](../build/build.md#overdue-builds) for more information.
|
||||
|
||||
### Target Date for Sales Order
|
||||
|
||||
@ -29,7 +29,7 @@ Refer to the [build documentation](../../build/build/#overdue-builds) for more i
|
||||
### Stock Ownership
|
||||
|
||||
[#1155](https://github.com/inventree/InvenTree/pull/1155) adds ownership to stock locations and items. Ownership allows control over which user group or individual user can edit and manage specific stock locations and items.
|
||||
For further information, refer to the [ownership documentation](../../stock/owner).
|
||||
For further information, refer to the [ownership documentation](../stock/owner.md).
|
||||
|
||||
### Calendar Views
|
||||
|
||||
@ -41,7 +41,7 @@ For further information, refer to the [ownership documentation](../../stock/owne
|
||||
|
||||
### Improved Label Printing
|
||||
|
||||
[#1212](https://github.com/inventree/InvenTree/pull/1212) significantly improves the existing label printing functionality. Documentation for the new label printing system [can be found here](../../report/labels).
|
||||
[#1212](https://github.com/inventree/InvenTree/pull/1212) significantly improves the existing label printing functionality. Documentation for the new label printing system [can be found here](../report/labels.md).
|
||||
|
||||
### Improved Report Printing
|
||||
|
||||
|
||||
@ -19,18 +19,18 @@ Support for report templates has been greatly improved, moving towards "out of t
|
||||
- Adjustable page size for generated reports
|
||||
- Debug mode (renders reports as simple HTML files)
|
||||
|
||||
Refer to the [report documentation](../../report/report) for further information.
|
||||
Refer to the [report documentation](../report/report.md) for further information.
|
||||
|
||||
!!! warning "LaTeX Support"
|
||||
LaTeX report templates are no longer supported for a number of technical and ideological reasons
|
||||
|
||||
[#1292](https://github.com/inventree/InvenTree/pull/1292) adds support for build order / work order reports. Refer to the [build report documentation](../../report/build) for further information.
|
||||
[#1292](https://github.com/inventree/InvenTree/pull/1292) adds support for build order / work order reports. Refer to the [build report documentation](../report/build.md) for further information.
|
||||
|
||||
### Inherited BOM Items
|
||||
|
||||
[#1313](https://github.com/inventree/InvenTree/pull/1313) adds support for inherited BOM items, allowing greater flexibility for Bill of Materials management when combined with the Template / Variant part system.
|
||||
|
||||
Refer to the [BOM documentation](../../build/bom) for further information.
|
||||
Refer to the [BOM documentation](../build/bom.md) for further information.
|
||||
|
||||
### Stock Item Packaging
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Label printing functionality has been simplified and brought into line with the
|
||||
[#1342](https://github.com/inventree/InvenTree/pull/1342) represents a significant refactor of the label printing code.
|
||||
|
||||
!!! info "More Information"
|
||||
Refer to the [label printing documentation](../../report/labels) for further details.
|
||||
Refer to the [label printing documentation](../report/labels.md) for further details.
|
||||
|
||||
### Display Sub Builds
|
||||
|
||||
@ -31,7 +31,7 @@ Label printing functionality has been simplified and brought into line with the
|
||||
|
||||
### API Permissions
|
||||
|
||||
[#1363](https://github.com/inventree/InvenTree/pull/1363) enforces user role permissions onto the REST API endpoints. Authenticated users can now only perform REST actions which align with their allocated role(s). Refer to the [API documentation](../../extend/api/#authorization) for further information.
|
||||
[#1363](https://github.com/inventree/InvenTree/pull/1363) enforces user role permissions onto the REST API endpoints. Authenticated users can now only perform REST actions which align with their allocated role(s). Refer to the [API documentation](../extend/api.md#authorization) for further information.
|
||||
|
||||
### Query Pagination
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ title: Release 0.1.8
|
||||
|
||||
### Assign by Serial Number
|
||||
|
||||
[#1426](https://github.com/inventree/InvenTree/pull/1426) introduces a new feature which allows stock items to be allocated to a sales order using serial number references. This provides a much more streamlined user experience. Refer to the [sales order documentation](../../companies/so/) for further information.
|
||||
[#1426](https://github.com/inventree/InvenTree/pull/1426) introduces a new feature which allows stock items to be allocated to a sales order using serial number references. This provides a much more streamlined user experience. Refer to the [sales order documentation](../companies/so.md) for further information.
|
||||
|
||||
## Major Bug Fixes
|
||||
|
||||
|
||||
@ -12,10 +12,10 @@ This release adds a "background worker" - a separately managed process which all
|
||||
|
||||
This feature is critical for the InvenTree development path, allowing (in future releases) for complex tasks to be handled, such as email support, automatic report generation, and integration with third party services.
|
||||
|
||||
For more information on the background worker, refer to the [background tasks documentation](../../admin/tasks).
|
||||
For more information on the background worker, refer to the [background tasks documentation](../admin/tasks.md).
|
||||
|
||||
!!! info "Installation"
|
||||
Instructions for managing the background worker process are included in the [installation guide](../../start/install).
|
||||
Instructions for managing the background worker process are included in the [installation guide](../start/install.md).
|
||||
|
||||
!!! warning "Upgrading"
|
||||
If you are upgrading your InvenTree installation from an older version, you will need to ensure that you are also now running the background worker process!
|
||||
@ -31,4 +31,4 @@ To simplify this, an official InvenTree docker image is available on [DockerHub]
|
||||
!!! success "Docker Is the Way"
|
||||
Docker is now the recommended way to install InvenTree
|
||||
|
||||
Refer to the [docker setup guide](../../start/docker) for further information!
|
||||
Refer to the [docker setup guide](../start/docker.md) for further information!
|
||||
|
||||
@ -26,13 +26,13 @@ sourcing information for a part. Soon, InvenTree will allow the use of
|
||||
manufacturer data directly in purchase orders.
|
||||
|
||||
Details on how to create and manage manufacturer parts were added
|
||||
[here](../../companies/manufacturer/#add-manufacturer-part).
|
||||
[here](../companies/manufacturer.md#add-manufacturer-part).
|
||||
|
||||
### URL-style QR Code for StockItem
|
||||
|
||||
[#1462](https://github.com/inventree/InvenTree/pull/1417) adds the ability to
|
||||
create a QR code containing the URL of a StockItem, which can be opened directly
|
||||
on a portable device using the camera or a QR code scanner. More details [here](../../report/labels#url-style-qr-code).
|
||||
on a portable device using the camera or a QR code scanner. More details [here](../report/labels.md#url-style-qr-code).
|
||||
|
||||
## Major Bug Fixes
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ title: Release 0.2.2
|
||||
|
||||
### Build Order Improvements
|
||||
|
||||
[#1492](https://github.com/inventree/InvenTree/pull/1492) drastically improves the build order process, streamlining the stock allocation process and providing a more intuitive user experience. Refer to the [build order documentation](../../build/build) for further information.
|
||||
[#1492](https://github.com/inventree/InvenTree/pull/1492) drastically improves the build order process, streamlining the stock allocation process and providing a more intuitive user experience. Refer to the [build order documentation](../build/build.md) for further information.
|
||||
|
||||
### Javascript Translation
|
||||
|
||||
@ -58,7 +58,7 @@ title: Release 0.2.2
|
||||
|
||||
[#1600](https://github.com/inventree/InvenTree/pull/1600) adds a settings page for managing currency conversion, and provides support for manual currency exchange rate input
|
||||
|
||||
For more information refer to the [pricing documentation](../../part/pricing).
|
||||
For more information refer to the [pricing documentation](../part/pricing.md).
|
||||
|
||||
## Major Bug Fixes
|
||||
|
||||
|
||||
@ -8,15 +8,15 @@ For information on the latest and greatest InvenTree features, refer to the rele
|
||||
|
||||
| Release | Date |
|
||||
| ------- | ---- |
|
||||
| [0.2.3](../0.2.3) | *In Developement* |
|
||||
| [0.2.2](../0.2.2) | May 2021 |
|
||||
| [0.2.1](../0.2.1) | April 2021 |
|
||||
| [0.2.0](../0.2.0) | April 2021 |
|
||||
| [0.1.8](../0.1.8) | April 2021 |
|
||||
| [0.1.7](../0.1.7) | March 2021 |
|
||||
| [0.1.6](../0.1.6) | February 2021 |
|
||||
| [0.1.5](../0.1.5) | January 2021 |
|
||||
| [0.1.4](../0.1.4) | November 2020 |
|
||||
| [0.2.3](./0.2.3.md) | *In Developement* |
|
||||
| [0.2.2](./0.2.2.md) | May 2021 |
|
||||
| [0.2.1](./0.2.1.md) | April 2021 |
|
||||
| [0.2.0](./0.2.0.md) | April 2021 |
|
||||
| [0.1.8](./0.1.8.md) | April 2021 |
|
||||
| [0.1.7](./0.1.7.md) | March 2021 |
|
||||
| [0.1.6](./0.1.6.md) | February 2021 |
|
||||
| [0.1.5](./0.1.5.md) | January 2021 |
|
||||
| [0.1.4](./0.1.4.md) | November 2020 |
|
||||
|
||||
## Upcoming Features
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ title: Barcode Generation
|
||||
|
||||
## Barcode Generation
|
||||
|
||||
Both [report](../report) and [label](../labels) templates can render custom barcode data to in-line images.
|
||||
Both [report](./report.md) and [label](./labels.md) templates can render custom barcode data to in-line images.
|
||||
|
||||
!!! info "img"
|
||||
Barcode data must be rendered inside an `<img>` tag.
|
||||
|
||||
@ -100,7 +100,7 @@ Location Name: {{ location.name }}
|
||||
|
||||
### Barcodes
|
||||
|
||||
Refer to the [barcode documentation](../barcodes).
|
||||
Refer to the [barcode documentation](./barcodes.md).
|
||||
|
||||
### Conditional Formatting
|
||||
|
||||
@ -227,9 +227,9 @@ The following variables are made available to the StockItem label template:
|
||||
|
||||
### URL-style QR code
|
||||
|
||||
Stock Item labels support [QR code](../barcodes#qr-code) containing the stock item URL, which can be
|
||||
Stock Item labels support [QR code](./barcodes.md#qr-code) containing the stock item URL, which can be
|
||||
scanned and opened directly
|
||||
on a portable device using the camera or a QR code scanner. To generate a URL-style QR code for stock item in the [label HTML template](../labels#label-templates), add the
|
||||
on a portable device using the camera or a QR code scanner. To generate a URL-style QR code for stock item in the [label HTML template](./labels.md#label-templates), add the
|
||||
following HTML tag:
|
||||
|
||||
``` html
|
||||
|
||||
@ -103,7 +103,7 @@ Setting the *Debug Mode* option renders the template as raw HTML instead of PDF,
|
||||
|
||||
## Uploading Templates
|
||||
|
||||
Custom report templates can be uploaded using the [Admin Interface](../../admin/admin). Only users with admin access can upload and/or edit report template files.
|
||||
Custom report templates can be uploaded using the [Admin Interface(../admin/admin.md). Only users with admin access can upload and/or edit report template files.
|
||||
|
||||
## Report Assets
|
||||
|
||||
@ -193,17 +193,17 @@ InvenTree supports the following reporting functionality:
|
||||
|
||||
### Test Report
|
||||
|
||||
[Test Report](../test): Format results of a test report against for a particular StockItem
|
||||
[Test Report](./test.md): Format results of a test report against for a particular StockItem
|
||||
|
||||
### Packing List
|
||||
[Packing List](../pack): Format a list of items for shipping or transfer
|
||||
[Packing List](./pack.md): Format a list of items for shipping or transfer
|
||||
|
||||
### Build Report
|
||||
|
||||
[Build Order](../build): Format a build order report
|
||||
[Build Order](./build.md): Format a build order report
|
||||
|
||||
### Purchase Order
|
||||
[Purchase Order report](../order): Order line items
|
||||
[Purchase Order report](./order.md): Order line items
|
||||
|
||||
### Sales Order
|
||||
Sales Order: TODO
|
||||
|
||||
@ -4,7 +4,7 @@ title: Test Report
|
||||
|
||||
## Test Report
|
||||
|
||||
InvenTree provides [test result](../../stock/test) tracking functionality which allows the users to keep track of any tests which have been performed on a given stock item.
|
||||
InvenTree provides [test result](../stock/test.md) tracking functionality which allows the users to keep track of any tests which have been performed on a given stock item.
|
||||
|
||||
Custom test reports may be generated against any given stock item. All testing data is made available to the template for custom rendering as required.
|
||||
|
||||
|
||||
@ -84,7 +84,7 @@ The following database options can be configured:
|
||||
|
||||
## Email Settings
|
||||
|
||||
To enable [email functionality](../../admin/email), email settings must be configured here, either via environment variables or within the configuration file.
|
||||
To enable [email functionality](../admin/email.md), email settings must be configured here, either via environment variables or within the configuration file.
|
||||
|
||||
The following email settings are available:
|
||||
|
||||
|
||||
@ -5,12 +5,12 @@ title: Development Server
|
||||
## Development Server
|
||||
|
||||
!!! warning "Installation"
|
||||
Before continuing, ensure that the [installation steps](../install) have been completed.
|
||||
Before continuing, ensure that the [installation steps](./install.md) have been completed.
|
||||
|
||||
InvenTree includes a simple server application, suitable for use in a development environment.
|
||||
|
||||
!!! warning "Deployment"
|
||||
Refer to the [production server instructions](../production) to implement a much more robust server setup.
|
||||
Refer to the [production server instructions](./production.md) to implement a much more robust server setup.
|
||||
|
||||
### Running on a Local Machine
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ The InvenTree docker image contains all the required system packages, python mod
|
||||
|
||||
### Environment Variables
|
||||
|
||||
InvenTree run-time configuration options described in the [configuration documentation](../config) can be passed to the InvenTree container as environment variables.
|
||||
InvenTree run-time configuration options described in the [configuration documentation](./config.md) can be passed to the InvenTree container as environment variables.
|
||||
|
||||
The following environment variables for InvenTree server configuration are specified as part of the docker image, and can be overridden if required:
|
||||
|
||||
@ -46,7 +46,7 @@ Static files are stored internal to the container instance, at the location `/ho
|
||||
|
||||
### Configuration File
|
||||
|
||||
As discussed in the [configuration documentation](../config), InvenTree run-time settings can be provided in a configuration file.
|
||||
As discussed in the [configuration documentation](./config.md), InvenTree run-time settings can be provided in a configuration file.
|
||||
|
||||
By default, the docker container expects this configuration file in the location `/home/inventree/data/config.yaml`. If this file does not exist, it will be automatically created from a default template file.
|
||||
|
||||
@ -56,7 +56,7 @@ As this config file is inside the "data" directory (which should be mounted as a
|
||||
|
||||
InvenTree uses a secret key to provide cryptographic signing for the application.
|
||||
|
||||
As specified in the [configuration documentation](../config/#secret-key) this can be passed to the InvenTree application directly as an environment variable, or provided via a file.
|
||||
As specified in the [configuration documentation](./config.md#secret-key) this can be passed to the InvenTree application directly as an environment variable, or provided via a file.
|
||||
|
||||
By default, the InvenTree container expects the `INVENTREE_SECRET_KEY_FILE` to exist at `/home/inventree/data/secret_key.txt`. If this file does not exist, it will be created and a new key will be randomly generated.
|
||||
|
||||
@ -223,7 +223,7 @@ Alter (or add) environment variables into the docker-compose `environment` secti
|
||||
|
||||
A configuration file `config.yaml` has been created in the data volume (at the location specified on your local disk).
|
||||
|
||||
Edit this file (as per the [configuration guidelines](../config)).
|
||||
Edit this file (as per the [configuration guidelines](./config.md)).
|
||||
|
||||
### Run Web Server
|
||||
|
||||
|
||||
@ -214,7 +214,7 @@ InvenTree configuration can be performed using environment variables, or the `co
|
||||
Edit the configuration file at `/home/inventree/src/InvenTree/config.yaml`.
|
||||
|
||||
!!! info "Config Guidelines"
|
||||
Refer to the [configuration guidelines](../config) for full details.
|
||||
Refer to the [configuration guidelines](./config.md) for full details.
|
||||
|
||||
!!! warning "Configure Database"
|
||||
Ensure database settings are correctly configured before proceeding to the next step! In particular, check that the database connection settings match the database you have created in the previous step.
|
||||
@ -251,10 +251,10 @@ The InvenTree database is now setup and ready to run. A simple development serve
|
||||
|
||||
The InvenTree development server is useful for testing and configuration - and it may be wholly sufficient for a small-scale installation.
|
||||
|
||||
Refer to the [development server instructions](../development) for further information.
|
||||
Refer to the [development server instructions](./development.md) for further information.
|
||||
|
||||
### Production Server
|
||||
|
||||
In a production environment, a more robust server setup is required.
|
||||
|
||||
Refer to the [production server instructions](../production) for further information.
|
||||
Refer to the [production server instructions](./production.md) for further information.
|
||||
|
||||
@ -31,11 +31,11 @@ The bulk of the InvenTree code base supports the custom web server application.
|
||||
|
||||
The webserver code also provides a first-party API for performing database query actions.
|
||||
|
||||
Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as [Gunicorn](https://gunicorn.org/). For more information see the [deployment documentation](../deploy).
|
||||
Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as [Gunicorn](https://gunicorn.org/). For more information see the [deployment documentation](./production.md).
|
||||
|
||||
### Background Tasks
|
||||
|
||||
A separate application handles management of [background tasks](../../admin/tasks), separate to user-facing web requests.
|
||||
A separate application handles management of [background tasks](../admin/tasks.md), separate to user-facing web requests.
|
||||
|
||||
## OS Requirements
|
||||
|
||||
@ -123,7 +123,7 @@ There are multiple ways to get an InvenTree server up and running, of various co
|
||||
|
||||
The recommended method of installing InvenTree is to use [docker](https://www.docker.com). InvenTree provides out-of-the-box support for docker and docker-compose, which provides a simple, reliable and repeatable pipeline for integration into your production environment.
|
||||
|
||||
Refer to the [docker setup instructions](../docker) for further information.
|
||||
Refer to the [docker setup instructions](./docker.md) for further information.
|
||||
|
||||
### Bare Metal
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ This will create JSON file at the specified location which contains all database
|
||||
|
||||
### Initialize New Database
|
||||
|
||||
Configure the new database using the normal processes (see [Configuration](../config))
|
||||
Configure the new database using the normal processes (see [Configuration](./config.md))
|
||||
|
||||
Then, ensure that the database schema are correctly initialized in the new database:
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ title: Production Server
|
||||
## Production Server
|
||||
|
||||
!!! warning "Installation"
|
||||
Before continuing, ensure that the [installation steps](../install) have been completed.
|
||||
Before continuing, ensure that the [installation steps](./install.md) have been completed.
|
||||
|
||||
The following instructions provide a reasonably performant server, using [gunicorn](https://gunicorn.org/) as a webserver, and [supervisor](http://supervisord.org/) as a process manager.
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ The stock ownership feature is disabled by default, and must be enabled via the
|
||||
|
||||
### Owner: Group vs User
|
||||
|
||||
There are two types of owners in InvenTree: [groups](../../admin/permissions/#group) and [users](../../admin/permissions/#user).
|
||||
There are two types of owners in InvenTree: [groups](../admin/permissions.md#group) and [users](../admin/permissions.md#user).
|
||||
|
||||
* If a group is selected as owner, **all** users linked to the specified group will be able to edit the stock location or item.
|
||||
* If a user is selected as owner, only the specified user will be able to edit the stock location or item.
|
||||
@ -33,7 +33,7 @@ When selecting an owner, in the drop-down list, groups are annotated with the `(
|
||||
To specify the owner of a stock location, navigate to the stock location detail page. Click on the <span class='fas fa-sitemap'></span> icon under the location's name then click on "Edit Location".
|
||||
|
||||
!!! warning
|
||||
If you cannot see the <span class='fas fa-sitemap'></span> icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation](../../admin/permissions/#roles) and/or contact your InvenTree administrator.
|
||||
If you cannot see the <span class='fas fa-sitemap'></span> icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation/../admin/permissions.md#roles) and/or contact your InvenTree administrator.
|
||||
|
||||
In the "Edit Stock Location" form, select the owner and click the "Submit" button:
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ A stock location represents a physical real-world location where *Stock Items* a
|
||||
|
||||
## Stock Item
|
||||
|
||||
A *Stock Item* is an actual instance of a [*Part*](../../part/part) item. It represents a physical quantity of the *Part* in a specific location.
|
||||
A *Stock Item* is an actual instance of a [*Part*](../part/part.md) item. It represents a physical quantity of the *Part* in a specific location.
|
||||
|
||||
### Stock Item Details
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ title: Stock Test Result
|
||||
|
||||
Stock items which are associated with a *trackable* part can have associated test data - this is particularly useful for tracking unit testing / commissioning / acceptance data against a serialized stock item.
|
||||
|
||||
The master "Part" record for the stock item can define multiple [test templates](../../part/test/), against which test data can be uploaded. Additionally, arbitrary test information can be assigned to the stock item.
|
||||
The master "Part" record for the stock item can define multiple [test templates](../part/test.md), against which test data can be uploaded. Additionally, arbitrary test information can be assigned to the stock item.
|
||||
|
||||
!!! missing "TODO"
|
||||
Include pictures of the Test Results tab
|
||||
@ -44,7 +44,7 @@ Multiple results can be uploaded against the same test name. In cases where mult
|
||||
|
||||
### Automated Test Intgration
|
||||
|
||||
The stock item testing framework is especially useful when integrating with an automated acceptance testing framework. Test results can be uploaded using the [InvenTree API](../../extend/api/) or the [InvenTree Python Interface](../../extend/python/).
|
||||
The stock item testing framework is especially useful when integrating with an automated acceptance testing framework. Test results can be uploaded using the [InvenTree API](../extend/api.md) or the [InvenTree Python Interface](../extend/python.md).
|
||||
|
||||
!!! info "Example"
|
||||
You design and sell a temperature sensor which needs to be calibrated before it can be sold. An automated calibration tool sets the offset in the device, and uploads a test result to the InvenTree database.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user