Merge pull request #173 from eeintech/stock_status

Added stock status doc

docs/stock/status.md

@@ -0,0 +1,57 @@
+---
+title: Stock Status
+--- 
+
+## Stock Status
+
+Stock status serves at categorizing and identifying the state of stock items.
+
+Below is the current list of stock status and their proposed meaning:
+
+| Status      | Description |
+| ----------- | ----------- |
+| OK      | Stock item is healthy, nothing wrong to report       |
+| Attention needed   | Stock item hasn't been checked or tested yet       |
+| Damaged   | Stock item is not functional in its present state        |
+| Destroyed   | Stock item has been destroyed        |
+| Lost   | Stock item has been lost        |
+| Rejected   | Stock item did not pass the quality control standards        |
+| Returned   | Stock item was returned to seller (if bought) or is a customer return (if sold)        |
+
+Stock status code will remove the stock from certain operations. For instance, users can't add "destroyed" or "lost" stock to a sales order.
+ 
+The stock status is displayed as a label in the header of each stock item detail page, for instance here the stock status is "OK":
+
+{% with id="stock_status_label", url="stock/stock_status_label.png", description="Stock Status Label" %}
+{% include 'img.html' %}
+{% endwith %}
+
+## Update Status
+
+### Single Item
+
+To change the status of an individual stock item, click on the status label displayed in the stock item view, then select the new status:
+
+{% with id="stock_status_change", url="stock/stock_status_change.png", description="Stock Status Change" %}
+{% include 'img.html' %}
+{% endwith %}
+
+Submit the form then the label will be updated:
+
+{% with id="stock_status_label_updated", url="stock/stock_status_label_updated.png", description="Stock Status Label Updated" %}
+{% include 'img.html' %}
+{% endwith %}
+
+### Multiple Items
+
+In the "Stock" tab of the part view, select all stock items which stock status needs to be updated:
+
+{% with id="stock_status_change_multiple", url="stock/stock_status_change_multiple.png", description="Stock Status Status Multiple" %}
+{% include 'img.html' %}
+{% endwith %}
+
+Click on `Stock Options > Change stock status`, select the new status then submit. All selected stock items status will be automatically updated:
+
+{% with id="stock_status_change_multiple_done", url="stock/stock_status_change_multiple_done.png", description="Stock Status Status Multiple Done" %}
+{% include 'img.html' %}
+{% endwith %}

mkdocs.yml

@@ -68,6 +68,7 @@ nav:
     - Pricing: part/pricing.md
   - Stock:
     - Stock Items: stock/stock.md
+    - Stock Status: stock/status.md
     - Adjusting Stock: stock/adjust.md
     - Stocktake: stock/stocktake.md
     - Stock Expiry: stock/expiry.md