mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-16 03:55:41 +00:00
Fix common spelling mistakes (#4956)
* add codespell * first fixes * doc fixes * fix docstrings and comments * functional changes * docstrings again * and docs again * rename args * add ignore * use pre-commit for filtering instead * ups * fix typo in filter
This commit is contained in:
@ -40,7 +40,7 @@ The InvenTree server tries to locate the `config.yaml` configuration file on sta
|
||||
The configuration file *template* can be found on [GitHub](https://github.com/inventree/InvenTree/blob/master/InvenTree/config_template.yaml)
|
||||
|
||||
!!! info "Template File"
|
||||
The default configuration file (as defined by the template linked above) will be copied to the specifed configuration file location on first run, if a configuration file is not found in that location.
|
||||
The default configuration file (as defined by the template linked above) will be copied to the specified configuration file location on first run, if a configuration file is not found in that location.
|
||||
|
||||
!!! tip "Restart Server"
|
||||
The contents of the configuration file are read when the InevnTree server first launches. If any changes are made to the configuration file, ensure that the server is restarted, so that the changes can be made operational.
|
||||
|
@ -40,7 +40,7 @@ To enable access to the InvenTree server from other computers on a local network
|
||||
|
||||
## Background Worker
|
||||
|
||||
The backgroun task manager must also be started. The InvenTree server is already running in the foreground, so open a *new shell window* to start the server.
|
||||
The background task manager must also be started. The InvenTree server is already running in the foreground, so open a *new shell window* to start the server.
|
||||
|
||||
### Activate Virtual Environment
|
||||
|
||||
|
@ -161,7 +161,7 @@ docker compose run inventree-dev-server invoke update
|
||||
|
||||
### Docker Image Updates
|
||||
|
||||
Occassionally, the docker image itself may receive some updates. In these cases, it may be required that the image is rebuilt. To perform a complete rebuild of the InvenTree development image from local source, run the following command:
|
||||
Occasionally, the docker image itself may receive some updates. In these cases, it may be required that the image is rebuilt. To perform a complete rebuild of the InvenTree development image from local source, run the following command:
|
||||
|
||||
```
|
||||
docker compose build --no-cache
|
||||
|
@ -151,7 +151,7 @@ If you are creating the initial database, you need to create an admin (superuser
|
||||
docker compose run inventree-server invoke superuser
|
||||
```
|
||||
|
||||
Alternatively, admin account details can be specifed in the `.env` file, removing the need for this manual step:
|
||||
Alternatively, admin account details can be specified in the `.env` file, removing the need for this manual step:
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
@ -203,7 +203,7 @@ docker compose pull
|
||||
This ensures that the InvenTree containers will be running the latest version of the InvenTree source code.
|
||||
|
||||
!!! info "Tagged Version"
|
||||
If you are targetting a particular "tagged" version of InvenTree, you may wish to edit the `INVENTREE_TAG` variable in the `.env` file before issuing the `docker compose pull` command
|
||||
If you are targeting a particular "tagged" version of InvenTree, you may wish to edit the `INVENTREE_TAG` variable in the `.env` file before issuing the `docker compose pull` command
|
||||
|
||||
### Update Database
|
||||
|
||||
|
@ -307,7 +307,7 @@ invoke update
|
||||
|
||||
This command performs the following steps:
|
||||
|
||||
* Ensure all rquired packages are installed and up to date
|
||||
* Ensure all required packages are installed and up to date
|
||||
* Perform required database schema changes
|
||||
* Run the user through any steps which require interaction
|
||||
* Collect any new or updated static files
|
||||
|
@ -77,10 +77,10 @@ By default, InvenTree is served internally on port 6000 and then proxied via Ngi
|
||||
This only serves an HTTP version of InvenTree, to use HTTPS (recommended for production) or customise any further an additional config file should be used.
|
||||
|
||||
#### Extra python packages
|
||||
Extra python packages can be installed by setting the enviroment variable `SETUP_EXTRA_PIP`.
|
||||
Extra python packages can be installed by setting the environment variable `SETUP_EXTRA_PIP`.
|
||||
|
||||
#### Database Options
|
||||
The used database backend can be configured with enviroment variables (before the first setup) or in the config file after the installation. Check the [configuration section](./config.md#database-options) for more information.
|
||||
The used database backend can be configured with environment variables (before the first setup) or in the config file after the installation. Check the [configuration section](./config.md#database-options) for more information.
|
||||
|
||||
## Moving Data
|
||||
To change the data storage location, link the new location to `/opt/inventree/data`.
|
||||
|
@ -81,7 +81,7 @@ Installing the required Python packages inside a virtual environment allows a lo
|
||||
You can read more about Python virtual environments [here](https://docs.python.org/3/tutorial/venv.html).
|
||||
|
||||
!!! info "Virtual Environment"
|
||||
The installation intstruction assume that a virtual environment is configured
|
||||
The installation instruction assume that a virtual environment is configured
|
||||
|
||||
`cd` into the InvenTree directory, and create a virtual environment with the following command:
|
||||
|
||||
|
@ -43,7 +43,7 @@ This step ensures that the required database tables exist, and are at the correc
|
||||
|
||||
### Import Data
|
||||
|
||||
The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database.
|
||||
The new database should now be correctly initialized with the correct table structures required to import the data. Run the following command to load the databased dump file into the new database.
|
||||
|
||||
!!! warning "Empty Database"
|
||||
If the database is not *empty* (i.e. it contains data records) then the data import process will fail. If errors occur during the import process, run `invoke import-records` with the `-c` option to clear all existing data from the database.
|
||||
@ -85,7 +85,7 @@ Download the specific version of InvenTree you wish to update to.
|
||||
|
||||
### Run Update Process
|
||||
|
||||
Run the update and migration script using `invoke update`. This ensures that the database schema and records are udpated in the correct order.
|
||||
Run the update and migration script using `invoke update`. This ensures that the database schema and records are updated in the correct order.
|
||||
|
||||
### Restart Server
|
||||
|
||||
|
Reference in New Issue
Block a user