Merge branch 'master' of https://github.com/inventree/inventree-docs

_includes/img.html

@@ -7,7 +7,7 @@
 {% if 'http' in url %}
 {% set doc_url = url %}
 {% else %}
-{% set doc_url = '{{ assets }}/images/{{ url }}' %}
+{% set doc_url = assets  + '/images/' + url %}
 {% endif %}
 
 <figure class='image'>

docs/build/build.md

@@ -91,3 +91,10 @@ Finally, click on the "Complete Build" button to process the build completion.
 
 !!! warning "Completed Build"
 	**A completed build cannot be re-opened**. Make sure to use the confirm only if you are certain that the build is complete.
+
+### Overdue Builds
+
+Build orders may (optionally) have a target complete date specified. If this date is reached but the build order remains incomplete, then the build is considered *overdue*.
+
+- Builds can be filtered by overdue status in the build list
+- Overdue builds will be displayed on the home page

docs/releases/0.1.4.md

@@ -1,18 +1,16 @@
 ---
-title: What's New
+title: v0.1.4
 ---
 
-## What's New
-
-### Release 0.1.4
+## Release 0.1.4
 
 [Release 0.1.4](https://github.com/inventree/InvenTree/releases/tag/0.1.4) (November 2020) provides a number of major new features and improvements, as well as some crucial bug fixes:
 
-#### Build Management System
+### Build Management System
 
 The build management system has received a major upgrade, bringing the following improvements:
 
-##### Partial Build Completion
+#### Partial Build Completion
 
 Previously, build orders had to be completed *atomically* (i.e. if the build order was to create 20x units, then all 20x units had to be created at once).
 
@@ -20,34 +18,34 @@ The new build system allows the user to specify build *outputs* (of varying quan
 
 A *Build Output* is simply a StockItem object which is marked as *in production*. This stock item can be assigned a (unique) serial number which is useful for pre-allocation purposes. It also allows stock to be filtered by production status and determine how many units are being built.
 
-##### Stock Item Tracking
+#### Stock Item Tracking
 
 Parts which are marked as *trackable* are now treated differently for the purpose of a build order. Stock items must be assigned against each build output (as was the case previously). When a build output is marked as complete, any *trackable* stock items which are assigned to that build output are installed *into* the build output (which is simply a StockItem). In this manner, if a *trackable* stock item is used to build another stock item, it remains tracked via the stock item it is installed into.
 
 Stock items which are not *trackable* are simply removed from stock when the build output is completed.
 
-##### Stock Allocation Improvements
+#### Stock Allocation Improvements
 
 A number of UX improvements have been made to simplify the process of allocating stock items against a build output (and thus a build order).
 
-#### Related Parts
+### Related Parts
 
 Related Part denotes a relationship between two parts, when users want to show their usage is "related" to another part or simply emphasize a link between two parts.
 
-##### Implementation
+#### Implementation
 
 - New PartRelated model/table to store relationships between parts (requires migration)
 - New Related tab shown in Part detail page
 - Ability to add relationships between parts through both main and admin interfaces
 - Can only manage relationship if user has "change" permission on Part ruleset
 
-##### Example View
+#### Example View
 
 {% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/96306587-8f2d0b80-0fc5-11eb-8fdb-20cb2dabfcc6.png", description="Related Parts Example View" %}
 {% include 'img.html' %}
 {% endwith %}
 
-#### InvenTree "Global" Settings
+### InvenTree "Global" Settings
 
 Global settings control the default value of fields across the entire web interface, for all-users.
 
@@ -65,16 +63,16 @@ For Category section, read [Category Parameter Templates](#category-parameter-te
 
 Other section allows to set the prefix of build, puchase and sales orders.
 
-#### Category Parameter Templates
+### Category Parameter Templates
 
 Added support for configuring parameter templates defined by categories.
 
-##### Features
+#### Features
 
 * User can now setup a list of parameter templates for each (or all) part category(ies) in InvenTree settings
 * During part creation, part parameters are automatically created using the list of parameter templates from the parent category it belongs to (if option is enabled)
 
-##### Screenshots
+#### Screenshots
 
 * Select category
 
@@ -100,8 +98,7 @@ Added support for configuring parameter templates defined by categories.
 {% include 'img.html' %}
 {% endwith %}
 
-
-#### Currency Support
+### Currency Support
 
 A more comprehensive implementation of Currency support has been implemented.
 

docs/releases/0.1.5.md

@@ -0,0 +1,29 @@
+---
+title: v0.1.5
+---
+
+## Release 0.1.5
+
+!!! info "Development Version"
+    v0.1.5 is currently in development and has not yet been released
+
+[Release 0.1.5](https://github.com/inventree/InvenTree/releases/tag/0.1.5) (November 2020) provides a number of major new features and improvements, as well as some crucial bug fixes:
+
+## New Features
+
+### Target Date for Build Order
+
+[#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.
+
+### Target Date for Sales Order
+
+[#1177](https://github.com/inventree/InvenTree/pull/1177) introduces the concept of *Target Date* for a Sales Order. This is the intended shipment date for the order. If the date is reached but the order is not yet complete, the order is considered *overdue*.
+
+## Major Bug Fixes
+
+| PR | Description |
+| --- | --- |
+| [#1144](https://github.com/inventree/InvenTree/pull/1144) | Fixes infinite loop recursion when displaying BOM table |
+| [#1175](https://github.com/inventree/InvenTree/pull/1175) | Fixes display of buttons in particular StockItem tab |

docs/releases/new.md

@@ -0,0 +1,12 @@
+---
+title: What's New
+---
+
+## What's New
+
+For information on the latest and greatest InvenTree features, refer to the release documentation below:
+
+| Release | Date |
+| ------- | ---- |
+| [0.1.4](../0.1.4) | November 2020 |
+

docs/report/labels.md

@@ -54,5 +54,5 @@ In addition to the global label context data, the following variables are made a
 * quantity - *The `quantity` field of the StockItem object*
 * serial - *The `serial` field of the StockItem object*
 * uid - *The `uid` field of the StockItem object*
-* qrcode - *JSON data representing the StockItem object, useful for rendering to a QR code*
+* qr_data - *JSON data representing the StockItem object, useful for rendering to a QR code*
 * tests - *Dict object of TestResult data associated with the StockItem*

docs/start/config.md

@@ -40,7 +40,7 @@ MySQL database backend is supported with the native Django implemetation. To run
 To install these required packages, run the following command:
 
 ```
-invoke mysql
+inv mysql
 ```
 
 It is then up to the database adminstrator to create a new MySQL database to store inventree data, in addition to a username/password to access the data.
@@ -61,7 +61,7 @@ PostgreSQL database backend is supported with the native Django implementation.
 To install these required packages, run the following commands:
 
 ```
-invoke postgresql
+inv postgresql
 ```
 
 It is then up to the database adminstrator to create a new PostgreSQL database to store inventree data, in addition to a username/password to access the data.

docs/start/deploy.md

@@ -19,7 +19,7 @@ The InvenTree development server is useful for testing and configuration - and i
 To run the development server on a local machine, run the command:
 
 ```
-invoke server -a 127.0.0.1:8000
+inv server -a 127.0.0.1:8000
 ```
 
 Serving on the address `127.0.0.1` means that InvenTree will only be available *on that computer*. The server will be accessible from a web browser on the same computer, but not from any other computers on the local network.
@@ -29,7 +29,7 @@ Serving on the address `127.0.0.1` means that InvenTree will only be available *
 To enable access to the InvenTree server from other computers on a local network, you need to know the IP of the computer running the server. For example, if the server IP address is `192.168.120.1`:
 
 ```
-invoke server -a 192.168.120.1:8000
+inv server -a 192.168.120.1:8000
 ```
 
 !!! warning "Not For Production"
@@ -59,7 +59,7 @@ Directories for storing *media* files and *static* files should be specified in
 The required static files must be collected into the specified ``STATIC_ROOT`` directory:
 
 ```
-invoke static
+inv static
 ```
 
 This command collects all of the required static files (including script and css files) into the specified directory ready to be served.

docs/start/install.md

@@ -111,7 +111,7 @@ pip3 install invoke
 To display a list of the available configuration scripts, run the following command:
 
 ```
-invoke --list
+inv --list
 ```
 
 ## Download Source Code
@@ -140,7 +140,7 @@ Now that the source code is downloaded (and optionally you have configured a Pyt
 To setup the InvenTree environment, run the following commands (from the InvenTree source directory):
 
 ```
-invoke install
+inv install
 ```
 
 This installs all required Python packages using pip package manager. It also creates a (default) database configuration file which needs to be edited to meet user needs before proceeding (see next step below).
@@ -166,7 +166,7 @@ For further information on installation configuration, refer to the [Configurati
 Once install settings are correctly configured (in *config.yaml*) run the initial setup script:
 
 ```
-invoke migrate
+inv migrate
 ```
 
 This performs the initial database migrations, creating the required tables, etc.
@@ -178,11 +178,11 @@ The database should now be installed!
 Create an initial superuser (administrator) account for the InvenTree instance:
 
 ```
-invoke superuser
+inv superuser
 ```
 
 !!! warning "Solving Cairo Errors"
-	In the case the above command returns errors with the `Cairo` package, it implies that dependencies for the `weasyprint` package are not installed on the system. To solve them, run through the [weasyprint installation steps](https://weasyprint.readthedocs.io/en/stable/install.html) then re-run `invoke install` and `invoke superuser`.
+	In the case the above command returns errors with the `Cairo` package, it implies that dependencies for the `weasyprint` package are not installed on the system. To solve them, run through the [weasyprint installation steps](https://weasyprint.readthedocs.io/en/stable/install.html) then re-run `inv install` and `inv superuser`.
 
 ### Run Development Server
 
@@ -191,13 +191,13 @@ The InvenTree database is now setup and ready to run. A simple development serve
 To launch the development server, run the following commands:
 
 ```
-invoke server
+inv server
 ```
 
 For more server options, run:
 
 ```
-invoke server -h
+inv server -h
 ```
 
 This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For other options refer to the [django docs](https://docs.djangoproject.com/en/2.2/ref/django-admin/)

docs/start/migrate.md

@@ -12,14 +12,14 @@ For example, if you wish to migrate from an SQLite database backend to a MySQL d
 	Ensure that the original database is securely backed up first!
 
 !!! info "Up to Date"
-    Ensure that the original database is up to date, by running `invoke migrate`
+    Ensure that the original database is up to date, by running `inv migrate`
 
 ### Export Data
 
 Export the database contents to a JSON file using the following command:
 
 ```
-invoke export-records -f data.json
+inv export-records -f data.json
 ```
 
 This will create JSON file at the specified location which contains all database records.
@@ -34,7 +34,7 @@ Configure the new database using the normal processes (see [Configuration](../co
 Then, ensure that the database schema are correctly initialized in the new database:
 
 ```
-invoke migrate
+inv migrate
 ```
 
 This ensures that the required database tables exist, which must be the case before data can be imported.
@@ -44,7 +44,7 @@ This ensures that the required database tables exist, which must be the case bef
 The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database.
 
 ```
-invoke import-records -f data.json
+inv import-records -f data.json
 ```
 
 !!! info "Import Filename"

docs/start/update.md

@@ -28,7 +28,7 @@ git pull origin master
 Updating the database is as simple as calling the `update` script:
 
 ```
-invoke update
+inv update
 ```
 
 This command performs the following steps:

mkdocs.yml

@@ -38,7 +38,7 @@ extra_javascript:
 nav:
   - InvenTree:
     - About InvenTree: index.md
-    - What's New: new.md
+    - What's New: releases/new.md
     - Contribute: contribute.md
   - Getting Started:
     - Installation: start/install.md