inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-14 19:15:41 +00:00
Code Activity

Documentation integration (#4653)

Browse Source 
* Add documentation under docs/ directory

* Add CI workflow for mkdocs configuration checking

* Add documentation issue template

* update pip-tools?

* Update .gitignore files

* Fix .gitignore rules

* Improve release notes page

* remove references to old repo
This commit is contained in:
Oliver
2023-04-22 22:40:29 +10:00
committed by GitHub
parent 20f01e8741
commit 2ffd2354eb
487 changed files with 44875 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/docs/stock/test.md Normal file
View File

@ -0,0 +1,50 @@
---
title: Stock Test Result
---
## 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.md), against which test data can be uploaded. Additionally, arbitrary test information can be assigned to the stock item.
{% with id="stock_test_results", url="stock/test_results.png", description="Stock Item Test Results" %}
{% include 'img.html' %}
{% endwith %}
### Test Result Fields
#### Test Name
The name of the test data is used to associate the test with a test template object.
#### Result
Boolean pass/fail status of the test.
#### Value
Optional value uploaded as part of the test data. For example if the test is to record the firmware version of a programmed device, the version number can be added here.
#### Notes
Optional field available for extra notes.
#### Attachment
A given test result may require an attached file which contains extra test information.
### Multiple Test Results
Multiple results can be uploaded against the same test name. In cases where multiple test results are uploaded, the most recent value is used to determine the pass/fail status of the test. It is useful to keep all test records as a given test might be required to run multiple times, if (for example) it fails the first time and then something must be fixed before running the test again.
### Reporting
For any information regarding the reporting architecture, please refer to the [Report Generation](../report/report.md) page.
### 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](../api/api.md) or the [InvenTree Python Interface](../api/python/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.