diff --git a/_includes/donate.html b/_includes/donate.html deleted file mode 100644 index 33e6183..0000000 --- a/_includes/donate.html +++ /dev/null @@ -1,8 +0,0 @@ -
- - - - - -
- \ No newline at end of file diff --git a/docs/assets/images/build/build_complete.png b/docs/assets/images/build/build_complete.png new file mode 100644 index 0000000..b83237c Binary files /dev/null and b/docs/assets/images/build/build_complete.png differ diff --git a/docs/assets/images/build/build_start_new.png b/docs/assets/images/build/build_start_new.png new file mode 100644 index 0000000..0868f91 Binary files /dev/null and b/docs/assets/images/build/build_start_new.png differ diff --git a/docs/assets/paypal-logo-small-min-300x136.png b/docs/assets/paypal-logo-small-min-300x136.png new file mode 100644 index 0000000..9a71b50 Binary files /dev/null and b/docs/assets/paypal-logo-small-min-300x136.png differ diff --git a/docs/build/build.md b/docs/build/build.md index f5c7127..39b2b8f 100644 --- a/docs/build/build.md +++ b/docs/build/build.md @@ -18,15 +18,72 @@ A "basic" build flow is as follow: ##### Future Features -| Feature | Status | -| ----------- | ------------------------------------ | -| Edit completed build | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/993) | -| Track subparts | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/991) | -| Partial builds | :material-close: Not yet supported | +| Feature | Status | +| ----------- | ----------- | +| Allow edit of completed builds | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/993) | +| Track subparts used in build | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/991) | +| Partial build completion | :material-close: Not yet supported | + +### Build Status + +| Status | Description | +| ----------- | ----------- | +| `Pending` | "Build Order" has been created and build is ready for subpart allocation | +| `Allocated` | All subparts stocks in the part BOM have been allocated | +| `Cancelled` | Build has been cancelled | +| `Completed` | Build has been completed | ### Part BOM -Read through the [Bill of Materials documentation](/build/bom) to setup a part BOM before creating a "Build Order". +A Part BOM is required to allocate inventory to a build. -!!! missing "TODO" - This section requires further work +Read through the [Bill of Materials documentation](/build/bom). + +### Build Order + +Builds orders are used to create parts builds. + +To create a build order for your part, you have two options: + +1. navigate to the Part detail page, click on "Build Orders" tab then click on "Start New Build" button +0. navigate to the Build page, click on "New Build Order" + +{% with id="build_start_new", url="build/build_start_new.png", description="Start New Build Form" %} +{% include 'img.html' %} +{% endwith %} + +Fill-out the form then click the "Submit" button to create the build. + +### Stock Allocation + +To allocate stock for a build, you have two options: + +1. automatic allocation: if each subpart has only **one** storage location, InvenTree can allocate stock from this location automatically +0. manual allocation: user can define allocation for each subpart in the build + +#### Automatic Allocation + +Click on the "Allocated Parts tab" then click on the "Auto Allocate" button to automatically allocate stock. + +#### Manual Allocation + +Click on the "Allocated Parts tab" then click on the :fontawesome-solid-plus: icon next to each subpart in the build to manually allocate stock. + +### Cancel Build + +To cancel a build, click on :fontawesome-regular-times-circle: icon on the build detail page. + +The `Cancel Build` form will be displayed, click on the confirmation switch then click on the "Cancel Build" button to process the build cancellation. + +!!! warning "Cancelled Build" + **A cancelled build cannot be re-opened**. Make sure to use the cancel option only if you are certain that the build won't be processed. + +### Complete Build + +To complete a build, click on :fontawesome-solid-tools: icon on the build detail page, the `Complete Build` form will be displayed. + +!!! info "Incomplete Allocation" + If the warning message `Warning: Build order allocation is not complete` is shown, make sure to allocate stock for the build before proceeding with build completion. + +Select a `Location` to store the resulting parts from the build then click on the confirmation switch. +Finally, click on the "Complete Build" button to process the build completion. diff --git a/docs/part/template.html b/docs/contribute.html similarity index 89% rename from docs/part/template.html rename to docs/contribute.html index d50faea..f330e08 100644 --- a/docs/part/template.html +++ b/docs/contribute.html @@ -1055,21 +1055,22 @@ body .markdown-body .codehilite .vi{color:teal} .codehilite .il{color:#009999} .codehilite .gc{color:#999;background-color:#EAF2F5} -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 +Contributing to InvenTree

Contribute to InvenTree

+

InvenTree is an open source project, and benefits greatly from user contributions.

+

If you find InvenTree to be useful, and wish to improve the software, please consider contributing:

+

Source Code

+

InvenTree is built using Python3 and Django. Source code is available on GitHub.

+

Contributions towards the core InvenTree code base are welcomed; either extending current functionality, prodiving new features, or addressing outstanding issues.

+

Report Bugs

+

If you find a bug or a feature that does not work correctly, please report it on GitHub. Reporting bugs is critical to improving the software. If you are able and willing, providing a fix for any outstanding issues would be greatly appreciated.

+

Translation

+

InvenTree provides a translation layer for the web interface, this requires effort from translators to provide multi-lingual support. If you wish to translate InvenTree to a new language (or improve an existing translation), such contributions would be extremely useful. To provide translation improvements, refer to GitHub.

+
+

Translation Helper Script

+

A python script is provided to assist with translation. This script is located at ./InvenTree/script/translate.py

+
+

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.

+ +

If you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development.

+

Donate :material-emoticon-cool:

\ No newline at end of file diff --git a/docs/contribute.md b/docs/contribute.md index 8ce12aa..a4f52f4 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -34,4 +34,6 @@ Documenting a large software project is a challenging and ongoing effort. If you If you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development. -{% include 'donate.html' %} +[ Donate :material-emoticon-cool: ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE¤cy_code=AUD){: .md-button .md-button--primary } +PayPal Logo + diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 138eb37..00f4951 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -52,4 +52,3 @@ a[target="_blank"]:not([class*="md-"]):after { /* content: " " url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' viewBox='0 0 24 24'%3E%3Cpath fill='rgb(123,136,204)' d='M14,3V5H17.59L7.76,14.83L9.17,16.24L19,6.41V10H21V3M19,19H5V5H12V3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V12H19V19Z' /%3E%3C/svg%3E%0A");*/ content: " " url('../assets/open-in-new-custom.svg'); } - diff --git a/mkdocs.yml b/mkdocs.yml index 21d742f..869a31e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -78,8 +78,10 @@ plugins: # Extensions markdown_extensions: - admonition + - attr_list - pymdownx.details - - markdown.extensions.codehilite + - pymdownx.highlight + - pymdownx.superfences - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg