mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-21 06:16:29 +00:00
Documentation integration (#4653)
* 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
GitHub
33
docs/docs/app/app.md
Normal file
33
docs/docs/app/app.md
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
title: InvenTree Mobile App
|
||||
---
|
||||
|
||||
{% with directory="appgallery", per_page=2 %}
|
||||
{% include "carousel.html" %}
|
||||
{% endwith %}
|
||||
|
||||
-----
|
||||
|
||||
The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../api/api.md), the app provides immediate access to inventory data without requiring physical access to a computer.
|
||||
|
||||
Native barcode support provides a multitude of context-sensitive stock control actions, allowing streamlined inventory management at your fingertips. The app has been optimized for speed, providing instant access to stock knowledge and handy on-site functionality.
|
||||
|
||||
## Features
|
||||
|
||||
- View and edit part and stock information with a blazingly fast interface
|
||||
- Perform stock control actions on the go
|
||||
- Barcode integrations simply stock operations
|
||||
- Receive purchase orders and check in stock items
|
||||
- And many more!
|
||||
|
||||
## Download
|
||||
|
||||
The InvenTree app can be downloaded from either the Android or Apple app stores, or accessed via the links below:
|
||||
|
||||
### Android
|
||||
|
||||
<span class='fab fa-android'></span> [Android Play Store](https://play.google.com/store/apps/details?id=inventree.inventree_app).
|
||||
|
||||
### iOS
|
||||
|
||||
<span class='fab fa-apple'></span> [Apple App Store](https://apps.apple.com/au/app/inventree/id1581731101#?platform=iphone)
|
||||
32
docs/docs/app/barcode.md
Normal file
32
docs/docs/app/barcode.md
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
title: App Barcode Support
|
||||
---
|
||||
|
||||
## Barcode Support
|
||||
|
||||
One of the key elements of functionality provided by the InvenTree app is the native support for context-sensitive barcode scanning.
|
||||
|
||||
Barcode integration allows extremely efficient stock control, for information lookup and also performing various actions.
|
||||
|
||||
### Supported Codes
|
||||
|
||||
The following code types are known to be supported
|
||||
|
||||
**1D Codes**
|
||||
|
||||
- Code-39
|
||||
- Code-93
|
||||
- Code-128
|
||||
- ITF
|
||||
|
||||
**2D Codes**
|
||||
|
||||
- QR Code
|
||||
- Data Matrix
|
||||
- Aztec
|
||||
|
||||
## Actions
|
||||
|
||||
The InvenTree app uses barcodes where possible to provide efficient stock control operations.
|
||||
|
||||
If there is a new barcode feature you would like to see, [let us know on GitHub](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aapp)!
|
||||
68
docs/docs/app/connect.md
Normal file
68
docs/docs/app/connect.md
Normal file
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Connect to Server
|
||||
---
|
||||
|
||||
## Connect to InvenTree
|
||||
|
||||
Use of the InvenTree app assumes that you (the user) have access to an InvenTree server.
|
||||
|
||||
When first running the app, no profile has been configured. The *server* icon in the top-right corner of the home screen is <span style='color: red'>red</span>, indicating that there is no connection to an InvenTree server:
|
||||
|
||||
{% with id="no_server", url="app/initial.png", maxheight="240px", description="No server configured" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
Press on the server icon to navigate to the server selection view:
|
||||
|
||||
{% with id="no_profiles", url="app/no_profiles.png", maxheight="240px", description="No server configured" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
### Create Server
|
||||
|
||||
!!! success "Server Profiles"
|
||||
The app supports multiple server profiles, providing simple switching between different InvenTree servers and/or account profiles.
|
||||
|
||||
Press the <span class='fas fa-plus-circle blue'></span> button in the bottom-right corner of the screen to create a new server profile.
|
||||
|
||||
{% with id="add_profile", url="app/add_server_profile.png", maxheight="240px", description="Add server" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
Enter the required server details:
|
||||
|
||||
| Parameter | Description |
|
||||
| --- | --- |
|
||||
| **Name** | Name for the server profile (can be any value, simply for reference) |
|
||||
| **Server** | InvenTree server address (including port, if required). e.g. `http://inventree.myserver.com:8080` |
|
||||
| **Username** | Your account username (case sensitive) |
|
||||
| **Password** | Your account password (case sensitive) |
|
||||
|
||||
### Connect to Server
|
||||
|
||||
Once the server profile is created, you need to connect to the server. Simply short press on the server profile to connect.
|
||||
|
||||
Alternatively, long press on the server profile to activate the context menu, then select *Connect to Server*.
|
||||
|
||||
When the app successfully connects to the server, a success message is briefly displayed at the bottom of the screen. A green <span class='fas fa-check-circle green'></span> icon next to the server profile indicate that the profile is currently *selected* and also the connection was successful.
|
||||
|
||||
{% with id="connected", url="app/connected.png", maxheight="240px", description="Connected to server" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Connection Failure
|
||||
|
||||
If (for whatever reason) the app does not successfully connect to the InvenTree server, a failure message is displayed, and a red <span class='fas fa-times-circle red'></span> icon is displayed next to the server profile.
|
||||
|
||||
{% with id="failed", url="app/unauthorized.png", maxheight="240px", description="Connection failure" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
In this case, the error message displayed at the bottom of the screen provides context as to why the app could not successfully connect to the server.
|
||||
|
||||
To edit the server profile details, long press on the server profile, and select *Edit Server Profile*:
|
||||
|
||||
{% with id="edit", url="app/edit_server.png", maxheight="240px", description="Edit server profile" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
9
docs/docs/app/issues.md
Normal file
9
docs/docs/app/issues.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: App Suggestions / Issues
|
||||
---
|
||||
|
||||
## Suggestions / Issues
|
||||
|
||||
To suggest an improvement or new feature for the InvenTree app, or to report an issue, refer to the [InvenTree GitHub page](https://github.com/inventree/inventree-app/issues).
|
||||
|
||||
General feedback on the app is also welcomed - if you have any ideas on how to make the app more functional or effective, please let us know!
|
||||
62
docs/docs/app/navigation.md
Normal file
62
docs/docs/app/navigation.md
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
title: App Navigation
|
||||
---
|
||||
|
||||
|
||||
## Home Screen
|
||||
|
||||
The app *home screen* provides quick-access buttons for stock view and actions:
|
||||
|
||||
{% with id="home", url="app/home.png", maxheight="240px", description="Home screen" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
## Tab Display
|
||||
|
||||
Some screens provide multiple tabbed views, which are displayed at the top of the screen:
|
||||
|
||||
{% with id="global_nav", url="app/app_tabs.png", maxheight="240px", description="App tabs" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
Tabs can be navigated by pressing on the text of each tab, or by scrolling the screen left or right.
|
||||
|
||||
## Global Actions
|
||||
|
||||
The *Global Action* buttons are visible on most screens, displayed in the bottom left corner of the screen:
|
||||
|
||||
{% with id="global_nav", url="app/app_global_navigation.png", maxheight="240px", description="Global navigation actions" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Open Drawer Menu
|
||||
|
||||
The <span class='fas fa-list'></span> action opens the *Drawer Menu*, which is a quick-access menu for global navigation:
|
||||
|
||||
{% with id="drawer", url="app/drawer.png", maxheight="240px", description="Open drawer menu" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
The *Drawer Menu* can be accessed in the following ways:
|
||||
|
||||
- From the *Home Screen* select the *Drawer* icon in the top-left corner of the screen
|
||||
- From any other screen, long-press the *Back* button in the top-left corner of the screen
|
||||
|
||||
### Search
|
||||
|
||||
The <span class='fas fa-search'></span> action opens the [Search](./search.md) screen
|
||||
|
||||
### Scan Barcode
|
||||
|
||||
The <span class='fas fa-qrcode'></span> action opens the [barcode scan](./barcode.md) window, which allows quick access to the barcode scanning functionality.
|
||||
|
||||
## Context Actions
|
||||
|
||||
Within a given view, certain context actions may be available. If there are contextual actions which can be performed, they are displayed in the bottom right corner:
|
||||
|
||||
{% with id="drawer", url="app/context_actions.png", maxheight="240px", description="Context actions" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
!!! tip "Barcode Actions"
|
||||
Available barcode actions are displayed in a separate context action menu
|
||||
157
docs/docs/app/part.md
Normal file
157
docs/docs/app/part.md
Normal file
@ -0,0 +1,157 @@
|
||||
---
|
||||
title: Part Views
|
||||
---
|
||||
|
||||
## Part Category View
|
||||
|
||||
From the *home screen*, select *Parts* to open the top-level part category view.
|
||||
|
||||
### Details Tab
|
||||
|
||||
The *Details* tab shows information about the selected part category. In particular, it shows the name and description of the category, a link to the parent category (if available) and a list of subcategories.
|
||||
|
||||
{% with id="part-category", url="part_category_detail.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Parent Category
|
||||
|
||||
If the current category has a parent category (i.e. it is not a top-level category) then a link is provided to the parent category. Tap the *parent category* tile to navigate to the category detail page for the parent category.
|
||||
|
||||
#### Subcategories
|
||||
|
||||
If the current category has any subcategories, these are listed here. Select any of the subcategories to navigate to it.
|
||||
|
||||
### Parts Tab
|
||||
|
||||
The *Parts* tab displays all the parts available in this category. Tap a displayed part to navigate to the part detail view.
|
||||
|
||||
{% with id="cat-parts", url="category_parts_tab.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
The list of available parts can be filtered using the input box at the top of the screen:
|
||||
|
||||
{% with id="cat-parts-filter", url="category_parts_filter.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
### Context Actions
|
||||
|
||||
The following *Context Actions* are available for the selected category:
|
||||
|
||||
{% with id="cat-actions", url="category_actions_tab.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### New Category
|
||||
|
||||
Create a new subcategory under the current category:
|
||||
|
||||
{% with id="cat-new-cat", url="new_category.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### New Part
|
||||
|
||||
Create a new part within the current category:
|
||||
|
||||
{% with id="cat-new-part", url="new_part.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
### Edit Category
|
||||
|
||||
Select the *Edit* button in the top right corner of the screen to edit the details for the selected part category:
|
||||
|
||||
{% with id="cat-edit", url="part_category_edit.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
!!! info "Permission Required"
|
||||
If the user does not have permission to edit part details, this button will be hidden
|
||||
|
||||
In the part category display screen, there are three tabs of information available:
|
||||
|
||||
## Part Detail View
|
||||
|
||||
The *Part Detail* view displays information about a single part:
|
||||
|
||||
{% with id="part-details", url="part_details.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
### Details Tab
|
||||
|
||||
The *details* tab shows information about the selected part. Some of the displayed tiles provide further information when selected:
|
||||
|
||||
#### Category
|
||||
|
||||
Tap on the displayed part category to navigate to a detail view for that category.
|
||||
|
||||
#### Stock
|
||||
|
||||
The *stock* tile shows the total quantity of stock available for the part. Tap on this tile to navigate to the *Stock Tab* view for this part.
|
||||
|
||||
#### Notes
|
||||
|
||||
Tap on the *notes* tile to view (and edit) the notes for this part:
|
||||
|
||||
{% with id="part-notes", url="part_notes.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Attachments
|
||||
|
||||
Tap on the *attachments* tile to view the file attachments for this part:
|
||||
|
||||
{% with id="part-attachments", url="part_attachments.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
New attachments can be uploaded by tapping on the icons in the top right of the screen.
|
||||
|
||||
Select a particular attachment file to downloaded it to the local device.
|
||||
|
||||
### Stock Tab
|
||||
|
||||
The *Stock* tab displays all the stock items available for this part. Tap on a particular stock item to navigate to a detail view for that item.
|
||||
|
||||
{% with id="part-stock", url="part_stock.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
The list of available stock items can be filtered using the input box at the top of the screen.
|
||||
|
||||
### Actions Tab
|
||||
|
||||
The *Actions* tab displays the available actions for the selected part:
|
||||
|
||||
#### New Stock Item
|
||||
|
||||
Create a new stock item for this part:
|
||||
|
||||
{% with id="part-stock-new", url="new_stock_item.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
### Edit Part
|
||||
|
||||
To edit the part details, select the *Edit* button in the top right corner of the screen:
|
||||
|
||||
{% with id="part-edit", url="part_edit.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
!!! info "Permission Required"
|
||||
If the user does not have permission to edit part details, this button will be hidden
|
||||
|
||||
### Part Image View
|
||||
|
||||
Tap the image of the part (displayed at the top left of the screen) to launch the part image view:
|
||||
|
||||
{% with id="part-image", url="part_image.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
A full-screen view of the image is displayed. The user can also upload a new image for the part, either selecting an image from the device, or taking a new picture with the device's camera.
|
||||
49
docs/docs/app/po.md
Normal file
49
docs/docs/app/po.md
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Purchase Orders
|
||||
---
|
||||
|
||||
## Purchase Order List
|
||||
|
||||
The purchase order list display shows all current *outstanding* purchase orders. (Purchase orders which have been completed are not shown here).
|
||||
|
||||
{% with id="po_list", url="app/po_list.png", maxheight="240px", description="Purchase order list" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
Select an individual purchase order to display the detail view for that order.
|
||||
|
||||
### Filtering
|
||||
|
||||
Available purchase orders can be subsequently filtered using the search input at the top of the screen
|
||||
|
||||
## Purchase Order Detail
|
||||
|
||||
{% with id="po_detail", url="app/po_detail.png", maxheight="240px", description="Purchase order details" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
### Edit Order Details
|
||||
|
||||
From the detail view, select the *Edit* button in the top-right of the screen. This opens the purchase order editing display:
|
||||
|
||||
{% with id="edit_po", url="app/po_edit.png", maxheight="240px", description="Edit purchase order" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
### Line Items
|
||||
|
||||
The *Line Items* tab shows the line items associated with this purchase order:
|
||||
|
||||
{% with id="po_lines", url="app/po_lines.png", maxheight="240px", description="Purchase order line items" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
Long press on a particular line item to receive the item into stock.
|
||||
|
||||
### Stock Items
|
||||
|
||||
Once items have been received into stock against a particular purchase order, they are displayed in the *Stock Items* tab:
|
||||
|
||||
{% with id="po_stock", url="app/po_stock.png", maxheight="240px", description="Purchase order stock items" %}
|
||||
{% include "img.html" %}
|
||||
{% endwith %}
|
||||
46
docs/docs/app/privacy.md
Normal file
46
docs/docs/app/privacy.md
Normal file
@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Privacy Statement
|
||||
---
|
||||
|
||||
## InvenTree App Privacy Policy
|
||||
|
||||
The InvenTree mobile app requires some extra permissions for complete functionality. Additionally, some user information is stored locally on the device where the app is installed.
|
||||
|
||||
## Data Collection
|
||||
|
||||
### User Profiles
|
||||
|
||||
The InvenTree app requires the user to enter profile data to connect with an InvenTree server:
|
||||
|
||||
- Server address
|
||||
- Account username
|
||||
- Account password
|
||||
|
||||
Profile data is stored locally on the device, and can be deleted by the user if they wish. Profile data is only used for connection with an InvenTree server.
|
||||
|
||||
### Camera Permissions
|
||||
|
||||
The InvenTree app requires permission to access the device camera for the following purposes:
|
||||
|
||||
- Scanning barcode data
|
||||
- Taking pictures with the device camera for upload to connected InvenTree server
|
||||
|
||||
Pictures taken in the InvenTree app are not stored or distributed to any other services.
|
||||
|
||||
## Personal Information
|
||||
|
||||
The InvenTree app does not collect any information which could be used to personally identify the user(s) of the device onto which the app is installed.
|
||||
|
||||
## Third Party Access
|
||||
|
||||
The InvenTree app does not share any personal information on users of the app with any third parties.
|
||||
|
||||
## Error Logs
|
||||
|
||||
The InvenTree app makes use of the [sentry.io](https://sentry.io/) service to monitor the app for bugs and run-time errors. When an error occurs in the app, log data is uploaded to the sentry server, where InvenTree developers can use this information to improve the quality of the app.
|
||||
|
||||
!!! question "Identifying Information"
|
||||
The uploaded error reports contain information on the nature of the error / bug; i.e. "where" in the app code the failures occured. The uploaded data does not contain any information which can be used to identify users or extract user data.
|
||||
|
||||
!!! tip "Disable Error Reporting"
|
||||
If desired, users can disable error reporting entirely, from within the [app settings](./settings.md). This prevents any error logs from being uploaded to the sentry server.
|
||||
15
docs/docs/app/search.md
Normal file
15
docs/docs/app/search.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
title: App Search
|
||||
---
|
||||
|
||||
## Search Screen
|
||||
|
||||
The global search screen provides quick search functionality across the connected InvenTree database. Entering a search term will return multiple search results, as shown in the examples below:
|
||||
|
||||
{% with id="search_1", url="app/search_1.png", maxheight="240px", description="Search results" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
{% with id="search_2", url="app/search_2.png", maxheight="240px", description="Search results" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
62
docs/docs/app/settings.md
Normal file
62
docs/docs/app/settings.md
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
title: App Settings
|
||||
---
|
||||
|
||||
## Settings
|
||||
|
||||
The *Settings* view provides access to user configurable settings, in addition to information about the app itself.
|
||||
|
||||
The main settings view is shown below, and provides the following options:
|
||||
|
||||
- **Server** - Configure and select server profile
|
||||
- **App Settings** - Configure app settings
|
||||
- **Home Screen** - Configure home screen settings
|
||||
- **Part** - Configure part settings
|
||||
- **About** - Display app version information
|
||||
|
||||
{% with id="settings_view", url="app/settings.png", maxheight="240px", description="Settings view" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
## App Settings
|
||||
|
||||
The *App Settings* view provides configuration options for the InvenTree app:
|
||||
|
||||
{% with id="app_settings", url="app/app_settings.png", maxheight="240px", description="App Settings" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Parts
|
||||
|
||||
Configure options for "parts" display:
|
||||
|
||||
- **Include Subcategories** - When viewing a list of parts in a category, include parts from subcategories
|
||||
|
||||
### Stock
|
||||
|
||||
Configure options for "stock" display:
|
||||
|
||||
- **Include Sublocations** - When viewing a list of stock items in a location, include items from sublocations
|
||||
- **Stock History** - Display stock item history in the stock detail view
|
||||
|
||||
### Sounds
|
||||
|
||||
Configure audible app notifications:
|
||||
|
||||
- **Server Error** - Play an audible tone when a server error occurs
|
||||
- **Barcode Tones** - Play audible tones when scanning barcodes
|
||||
|
||||
### App Settings
|
||||
|
||||
- **Dark Mode** - Enable "dark mode" display for the app.
|
||||
- **Use Strict HTTPS** - Enforce strict checking of HTTPs certificates. Enabling this option may prevent you from connecting to the server if there are certificate issues.
|
||||
- **Language** - Select app language. By default, will use the system language of the device the app is installed on.
|
||||
- **Upload Error Reports** - Enable uploading of anonymous error / crash reports. These reports are used to improve the quality of the app.
|
||||
|
||||
## Home Screen
|
||||
|
||||
The *Home Screen* view allows you to configure display options for the app 'home screen':
|
||||
|
||||
{% with id="home_settings", url="app/home_settings.png", maxheight="240px", description="Home Screen Settings" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
171
docs/docs/app/stock.md
Normal file
171
docs/docs/app/stock.md
Normal file
@ -0,0 +1,171 @@
|
||||
---
|
||||
title: Stock Views
|
||||
---
|
||||
|
||||
## Stock Location View
|
||||
|
||||
From the *home screen*, select *Stock* to open the top-level stock location view.
|
||||
|
||||
### Details Tab
|
||||
|
||||
The *Details* tab shows information about the selected stock location.
|
||||
|
||||
{% with id="loc-detail", url="location_detail.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Parent Location
|
||||
|
||||
If the current location has a parent location (i.e. it is not a top-level location) then a link is provided to the parent location. Tap the *parent location* tile to navigate to the location detail page for the parent location.
|
||||
|
||||
#### Sublocations
|
||||
|
||||
If the current stock location has any sublocations, they are listed here. Select any of the displayed sublocations to navigate to the detail view.
|
||||
|
||||
### Stock Tab
|
||||
|
||||
The *Stock* tab displays all the stock items available in this location. Tap a displayed stock item to navigate to the stock item detail view.
|
||||
|
||||
{% with id="loc-stock", url="location_stock.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
The list of available stock items can be filtered using the input box at the top of the screen:
|
||||
|
||||
{% with id="loc-filter", url="location_stock_filter.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
### Context Actions
|
||||
|
||||
The following *Context Actions* are available for the selected location:
|
||||
|
||||
{% with id="loc-actions", url="location_actions.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
#### New Location
|
||||
|
||||
Create a new location under the current location:
|
||||
|
||||
{% with id="loc-new", url="new_location.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
#### New Stock Item
|
||||
|
||||
Create a new stock item in the current location:
|
||||
|
||||
{% with id="loc-new-stock", url="new_stock_item_from_location.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
#### Scan Stock Items Into Location
|
||||
|
||||
Use the barcode scanner to scan a stock item into the current location.
|
||||
|
||||
|
||||
## Stock Item Detail View
|
||||
|
||||
The *Stock Item Detail* view displays information about a single stock item:
|
||||
|
||||
{% with id="stock-detail", url="stock_detail.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
|
||||
### Details Tab
|
||||
|
||||
The *details* tab shows information about the selected stock item. Some of the displayed tiles provide further information when selected:
|
||||
|
||||
#### Part Tile
|
||||
|
||||
Part information is displayed at the top of the screen. Tap on this tile to navigate to the detail view for the linked part
|
||||
|
||||
#### Location
|
||||
|
||||
Tap on the location tile to navigate to the location detail view
|
||||
|
||||
#### Notes
|
||||
|
||||
Tap on the notes tile to display and edit the notes for this stock item
|
||||
|
||||
### Actions Tab
|
||||
|
||||
The *actions* tab displays the available actions for the selected stock item:
|
||||
|
||||
{% with id="stock-actions", url="stock_actions.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Count Stock
|
||||
|
||||
Select the *Count Stock* action to validate the current number of items in stock. Use this option to perform a quick stocktake!
|
||||
|
||||
{% with id="stock-count", url="stock_count.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
!!! info "Serialized Stock"
|
||||
The *count stock* action is not available for serialized stock items, as they have a fixed quantity of 1
|
||||
|
||||
#### Remove Stock
|
||||
|
||||
Select this action to remove a certain quantity from the selected stock item. For example, if there are 12 items available, and you take 3 items, the listed quantity will be reduced to 9 itemes.
|
||||
|
||||
{% with id="stock-remove", url="stock_remove.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Add Stock
|
||||
|
||||
Select this action to add a certain quantity to the selected stock item. For example, if there are 12 items available, and you add 3 items, the listed quantity will be increased to 15 items.
|
||||
|
||||
{% with id="stock-add", url="stock_add.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Transfer Stock
|
||||
|
||||
Transfer (move) the stock item to a new location:
|
||||
|
||||
{% with id="stock-transfer", url="stock_transfer.png" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
|
||||
#### Scan Into Location
|
||||
|
||||
Transfer the stock item into a new location by scanning the barcode for that location. If a *valid* stock location barcode is scanned, the stock item will be automatically relocated to that location
|
||||
|
||||
#### Assign Barcode
|
||||
|
||||
If a stock item has a third-party barcode (i.e. it has been received from a supplier with a barcode already printed) then this barcode can be used to track the stock item in InvenTree.
|
||||
|
||||
Select the *assign barcode* action to scan this third-party barcode and assign it to this stock item.
|
||||
|
||||
This barcode can then be used to track the stock item.
|
||||
|
||||
#### Print Label
|
||||
|
||||
If the server supports [label printing plugins](../extend/plugins/label.md), then an option to print a label for the selected stock item:
|
||||
|
||||
{% with id="label_print_1", url="stock_print_label_1.png", description="Print label via plugin" %}
|
||||
{% include 'app_img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
{% with id="label_print_2", url="stock_print_label_2.png", description="Print label via plugin" %}
|
||||
{% include 'app_img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Edit Stock Item
|
||||
|
||||
To edit the stock item details, select the *Edit* button in the top right corner of the screen:
|
||||
|
||||
{% with id="stock-edit", url="stock_edit.jpg" %}
|
||||
{% include "app_img.html" %}
|
||||
{% endwith %}
|
||||
15
docs/docs/app/translation.md
Normal file
15
docs/docs/app/translation.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
title: App Translations
|
||||
---
|
||||
|
||||
## Translation Support
|
||||
|
||||
The InvenTree app is designed to support multiple language translations.
|
||||
|
||||
As with the web application, translations are community contributed - if the app does not support your native language, contributions are very welcome!
|
||||
|
||||
## Contributing
|
||||
|
||||
Translation for the InvenTree mobile app is provided by the [crowdin](https://crowdin.com/project/inventree) service. Contributions are welcomed and encouraged, and the process of providing or improving translated strings is extremely simple!
|
||||
|
||||
Full translation efforts, while appreciated, are not required. Please feel free to contribute as much as you can!
|
||||
Reference in New Issue
Block a user