Nicer donate section, continued progress on build doc

_includes/donate.html

@@ -1,8 +0,0 @@
-<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
-    <input type="hidden" name="cmd" value="_donations" />
-    <input type="hidden" name="business" value="T4M976M5URSUE" />
-    <input type="hidden" name="currency_code" value="AUD" />
-    <input type="image" src="https://www.paypalobjects.com/en_AU/i/btn/btn_donateCC_LG.gif" border="0" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" />
-    <img alt="" border="0" src="https://www.paypal.com/en_AU/i/scr/pixel.gif" width="1" height="1" />
-</form>
-    

docs/build/build.md

@@ -19,14 +19,71 @@ 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)  |
+| Allow edit of completed builds | :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) |
+| Track subparts used in build | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/991) |
-| Partial builds   | :material-close: Not yet supported |
+| 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"
+Read through the [Bill of Materials documentation](/build/bom).
-	This section requires further work
+
+### 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.

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}
-</style><title>Part Templates</title></head><body><article class="markdown-body"><h2 id="part-templates">Part Templates<a class="headerlink" href="#part-templates" title="Permanent link"></a></h2>
+</style><title>Contributing to InvenTree</title></head><body><article class="markdown-body"><h2 id="contribute-to-inventree">Contribute to InvenTree<a class="headerlink" href="#contribute-to-inventree" title="Permanent link"></a></h2>
-<p>There are various purposes for using part templates, among them:
+<p>InvenTree is an open source project, and benefits greatly from user contributions.</p>
-* template parts can hold information that can be re-used across &ldquo;variants&rdquo;, a template part could be useful for creating a base variant of an assembly which can be derived from, with BoM changes for instance
+<p>If you find InvenTree to be useful, and wish to improve the software, please consider contributing:</p>
-* </p>
+<h3 id="source-code">Source Code<a class="headerlink" href="#source-code" title="Permanent link"></a></h3>
-<p>&ldquo;Variants&rdquo; parts will reference the &ldquo;Template&rdquo; part therefore explicitly creating and showing direct relationship.
+<p>InvenTree is built using <a href="https://www.python.org/">Python3</a> and <a href="https://www.djangoproject.com/">Django</a>. Source code is available on <a href="https://github.com/inventree/inventree">GitHub</a>.</p>
-They also allow you to do special things like:
+<p>Contributions towards the core InvenTree code base are welcomed; either extending current functionality, prodiving new features, or addressing outstanding issues.</p>
-* Serial Numbers
+<h3 id="report-bugs">Report Bugs<a class="headerlink" href="#report-bugs" title="Permanent link"></a></h3>
-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.</p>
+<p>If you find a bug or a feature that does not work correctly, please report it on <a href="https://github.com/inventree/inventree/issues">GitHub</a>. 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.</p>
-<p>Stock Reporting
+<h3 id="translation">Translation<a class="headerlink" href="#translation" title="Permanent link"></a></h3>
-The &ldquo;stock&rdquo; for a template part includes stock for all variants under that part</p>
+<p>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 <a href="https://github.com/inventree/inventree">GitHub</a>.</p>
-<p>Logical Grouping
+<div class="admonition info">
-The template / variant relationship is subtly different to the category / part relationship</p>
+<p class="admonition-title">Translation Helper Script</p>
-<h3 id="create-variant">Create Variant<a class="headerlink" href="#create-variant" title="Permanent link"></a></h3>
+<p>A python script is provided to assist with translation. This script is located at <code>./InvenTree/script/translate.py</code></p>
-<p>When a part&rsquo;s <a href="/part/views#part-options"><em>Template option</em></a> is turned-on, &ldquo;Variants&rdquo; of this part can be created.</p>
+</div>
-<p _="%" endwith="endwith">To create a variant, navigate to a specific part detail page, click on the &ldquo;Variants&rdquo; tab then click on the &ldquo;New Variant&rdquo; button.
+<h3 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link"></a></h3>
-The <code>Create Variant</code> form will be displayed:
+<p>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 <a href="https://github.com/inventree/inventree-docs">GitHub</a>.</p>
-{% with id=&rdquo;create_part_variant&rdquo;, url=&rdquo;part/create_part_variant.png&rdquo;, description=&rdquo;Create Part Variant Form&rdquo; %}
+<h3 id="donate">Donate<a class="headerlink" href="#donate" title="Permanent link"></a></h3>
-{% include &lsquo;img.html&rsquo; %}</p></article></body></html>
+<p>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.</p>
+<p><a class="md-button md-button--primary" href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&amp;business=T4M976M5URSUE&amp;currency_code=AUD">Donate :material-emoticon-cool: </a></p></article></body></html>

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&currency_code=AUD){: .md-button .md-button--primary }
+<img src="/assets/paypal-logo-small-min-300x136.png" border="0" alt="PayPal Logo" style="width: 102px; length:225px; vertical-align:middle;">
+

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');
 }
-

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