mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-04-27 05:06:43 +00:00
Docs cleanup (#347)
* remove 'contribute.md' - Will be moved to the website * Add reddit link * Remove demo page - Now documented on the main website * Update index page * Add link back to main website on index pgae * Update wording on index page * Replace demo page with a redirect link * Updated links
This commit is contained in:
Oliver
GitHub
parent
58353c4ac6
commit
8111117695
@ -22,13 +22,12 @@
|
||||
|
||||
<!-- Hero content -->
|
||||
<div class="mdx-hero__content">
|
||||
<a href="features" title="InvenTree features" class="md-button md-button">
|
||||
<span class='fas fa-star'></span> Features
|
||||
|
||||
<a href="https://inventree.org" title="InvenTree Website" class="md-button">
|
||||
<span class='fas fa-globe'></span> Website
|
||||
</a>
|
||||
<a href="demo" title="InvenTree demo" class='md-button'>
|
||||
<span class='fas fa-desktop'></span> Demo
|
||||
</a>
|
||||
<a href="start/intro" title="Install InvenTree" class="md-button md-button">
|
||||
|
||||
<a href="start/intro" title="Install InvenTree" class="md-button">
|
||||
<span class='fas fa-server'></span> Install
|
||||
</a>
|
||||
<a href="app/app" title="InvenTree mobile app" class="md-button">
|
||||
|
||||
@ -78,7 +78,7 @@ Each named field provides information on available attributes:
|
||||
|
||||
## Translation
|
||||
|
||||
Field *label* and *help text* values are localized using the [community contributed translations](../contribute.md#translation). The required locale information is determined from the API request itself, meaning that the translated values are provided automatically.
|
||||
Field *label* and *help text* values are localized using the [community contributed translations](https://crowdin.com/project/inventree). The required locale information is determined from the API request itself, meaning that the translated values are provided automatically.
|
||||
|
||||
For example, the same forms (in the web interface) are served via identical API requests, with the locale information determined "on the fly":
|
||||
|
||||
|
||||
@ -1,44 +0,0 @@
|
||||
---
|
||||
title: 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](https://www.python.org/) and [Django](https://www.djangoproject.com/). Source code is available on [GitHub](https://github.com/inventree/inventree).
|
||||
|
||||
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](https://github.com/inventree/inventree/issues). 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 both the web interface and mobile app. Native language translation 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 greatly appreciated!.
|
||||
|
||||
Native language translation of the InvenTree web application is [community contributed via crowdin](https://crowdin.com/project/inventree).
|
||||
|
||||
_**Contributions are welcomed and encouraged!**._
|
||||
|
||||
To contribute to the translation effort, navigate to the [InvenTree crowdin project](https://crowdin.com/project/inventree), create a free account, and start making translations suggestions for your language of choice!
|
||||
|
||||
### 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](https://github.com/inventree/inventree-docs).
|
||||
|
||||
If you see any sections of the documentation that require work (i.e. denoted with "TODO") - please consider providing assistance in these sections!
|
||||
|
||||
### Donate
|
||||
|
||||
Finally, 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 <span class='fas fa-smile'></span> ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE¤cy_code=AUD){: .md-button .md-button--primary }
|
||||
<img src="{{ config.assets_dir }}/paypal-logo-small-min-300x136.png" border="0" alt="PayPal Logo" style="width: 136px; length:300px; vertical-align:middle; padding-left: 20px">
|
||||
|
||||
Financial donations directly support the ongoing development of the InvenTree project. If you benefit from the InvenTree project, please consider contributing to maintain vibrant development of this software!
|
||||
109
docs/demo.md
109
docs/demo.md
@ -4,111 +4,4 @@ title: InvenTree Demo
|
||||
|
||||
## InvenTree Demo
|
||||
|
||||
A working demo of InvenTree is available online at:
|
||||
|
||||
<large><b>[https://demo.inventree.org](https://demo.inventree.org)</b></large>
|
||||
|
||||
### Login Details
|
||||
|
||||
Multiple default accounts are provided, as detailed below. Each account is afforded a different set of permissions, so users can see the InvenTree roles/permission system in action
|
||||
|
||||
| Username | Password | Description | Login link
|
||||
| --- | --- | --- | --- |
|
||||
| allaccess | nolimits | View / create / edit all pages and items | [log in](https://demo.inventree.org/accounts/login/?login=allaccess&password=nolimits) |
|
||||
| reader | readonly | Can view all pages but cannot create, edit or delete database records | [log in](https://demo.inventree.org/accounts/login/?login=reader&password=readonly) |
|
||||
| engineer | partsonly | Can manage parts, view stock, but no access to purchase orders or sales orders | [log in](https://demo.inventree.org/accounts/login/?login=engineer&password=partsonly) |
|
||||
| admin | inventree | Superuser account, access all areas plus administrator actions | [log in](https://demo.inventree.org/accounts/login/?login=admin&password=inventree) |
|
||||
|
||||
### Data Persistence
|
||||
|
||||
The InvenTree demo database resets to a known state once per day.
|
||||
|
||||
- Database records are reset to the latest state of the [demo dataset](https://github.com/inventree/demo-dataset)
|
||||
- InvenTree software is kept up to date with the latest `inventree:master` available via docker
|
||||
|
||||
!!! warning "Server Down"
|
||||
During the update period, the demo server may be inaccessible for a few minutes.
|
||||
|
||||
## Demo Dataset
|
||||
|
||||
The dataset used for the demo instance is [available on GitHub](https://github.com/inventree/demo-dataset).
|
||||
|
||||
This dataset can be used to populate an empty database for demonstration purposes, to test and evaluate various InvenTree features.
|
||||
|
||||
It may also be useful to developers who need a dataset for developing and/or testing new InvenTree features.
|
||||
|
||||
!!! warning "Empty Database"
|
||||
Loading demo data will cause errors if the database is not empty. Run `invoke delete-data` prior to importing the demo dataset if there are records existing in the database!
|
||||
|
||||
Follow these instructions to setup an InvenTree instance with the demo data:
|
||||
|
||||
### Download Dataset
|
||||
|
||||
Download the demo dataset, e.g. using git:
|
||||
|
||||
```
|
||||
git clone git@github.com:inventree/demo-dataset.git ~/inventree-data
|
||||
```
|
||||
|
||||
!!! info "Data Directory"
|
||||
For the purpose of these instructions it is assumed that the demo data repository has been cloned to ~/inventree-data.
|
||||
|
||||
### Initialize Database
|
||||
|
||||
You will need to configure an *empty* database before importing the data fixtures.
|
||||
|
||||
Follow the [installation instructions](./start/intro.md) to initialize a database using your backend of choice.
|
||||
|
||||
### Configure InvenTree Settings
|
||||
|
||||
You will need to adjust your InvenTree settings (either via environment variables or in the `config.yaml` file) as follows:
|
||||
|
||||
#### Media Files
|
||||
|
||||
Ensure that `INVENTREE_MEDIA_ROOT` points to the media files at ~/inventree-data/media
|
||||
|
||||
### Run Migrations
|
||||
|
||||
You will need to ensure that the database migrations are performed before importing records
|
||||
|
||||
```
|
||||
invoke migrate
|
||||
```
|
||||
|
||||
### Import Data
|
||||
|
||||
Now that you have an empty database (which has had the schema migrations applied) you can import the demo dataset:
|
||||
|
||||
```
|
||||
invoke import-records -f ~/inventree-data/inventree_data.json
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
Contributions to the demo dataset are encouraged! A richer dataset provides a better demo experience and helps to showcase the various features available in InvenTree.
|
||||
|
||||
To contribute back to the InvenTree demo dataset:
|
||||
|
||||
### Import Data
|
||||
|
||||
Follow the directions above to create an InvenTree instance using the latest demo dataset
|
||||
|
||||
### Git Branch
|
||||
|
||||
Create a git branch for the demo-dataset repository
|
||||
|
||||
### Edit Data
|
||||
|
||||
Create / edit / update the InvenTree database and media files as required
|
||||
|
||||
### Export Data
|
||||
|
||||
Export the updated data, overwriting the original data file:
|
||||
|
||||
```
|
||||
invoke export-records -f ~/inventree-data/inventree_data.json
|
||||
```
|
||||
|
||||
### Create Pull Request
|
||||
|
||||
Create a pull request on the [demo-dataset repository](https://github.com/inventree/demo-dataset) with the changes you have made.
|
||||
This page has moved to [https://inventree.org/demo.html](https://inventree.org/demo.html)
|
||||
|
||||
@ -3,15 +3,16 @@ title: InvenTree
|
||||
template: home.html
|
||||
hide:
|
||||
- toc
|
||||
- navigation
|
||||
---
|
||||
|
||||
## Intuitive Inventory Management
|
||||
|
||||
--------------
|
||||
|
||||
{% with directory="indexgallery", per_page=1 %}
|
||||
{% include "carousel.html" %}
|
||||
{% endwith %}
|
||||
InvenTree is an open-source inventory management system which provides intuitive parts management and stock control.
|
||||
|
||||
--------------
|
||||
|
||||
It is designed to be lightweight and easy to use for SME or hobbyist applications. Powerful business logic works in the background to ensure that stock tracking history is maintained, and users have ready access to stock level information. InvenTree is designed to allow for a flexible installation.
|
||||
|
||||
InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API.
|
||||
|
||||
----------------------
|
||||
@ -30,7 +30,7 @@ Persistent data (such as the stored database, media files, configuration files,
|
||||
|
||||
## Quickstart Guide
|
||||
|
||||
To get "up and running" with a development environment, complete with a set of [demo data](../demo.md) to work with, run the following commands:
|
||||
To get "up and running" with a development environment, complete with a set of [demo data](https://github.com/inventree/demo-dataset) to work with, run the following commands:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/inventree/InvenTree.git && cd InvenTree
|
||||
|
||||
@ -53,11 +53,10 @@ extra_javascript:
|
||||
# Navigation
|
||||
nav:
|
||||
- InvenTree:
|
||||
- InvenTree: index.md
|
||||
- Features: features.md
|
||||
- Release Notes: releases/release_notes.md
|
||||
- Demo: demo.md
|
||||
- FAQ: faq.md
|
||||
- Contribute: contribute.md
|
||||
- Credits: credits.md
|
||||
- Privacy: privacy.md
|
||||
- Terminology: terminology.md
|
||||
@ -224,6 +223,9 @@ extra:
|
||||
- icon: fontawesome/brands/docker
|
||||
link: https://hub.docker.com/r/inventree/inventree
|
||||
name: InvenTree on Docker
|
||||
- icon: fontawesome/brands/reddit
|
||||
name: InvenTree on Reddit
|
||||
link: https://reddit.com/r/inventree
|
||||
|
||||
use_directory_urls: true
|
||||
strict: true
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user