Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add comments and warnings to documentation so readers would follow the correct version (#5431)

Browse Source 
* add warning to use stable docs for stable docker_prod.md

* add notification and documentation column to different versions in docker.md
This commit is contained in:
Peter Kopias 2023-08-15 01:54:19 +02:00 committed by GitHub
parent e7b5b145bf
commit 58e06ba1cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/start/docker.md
View File

@ -11,6 +11,10 @@ The InvenTree docker image contains all the required system packages, python mod
!!! tip "Compose Yourself" !!! tip "Compose Yourself"
The InvenTree container requires linking with other docker containers (such as a database backend) for complete operation. Sample [docker compose](#docker-compose) scripts are provided to get you up and running The InvenTree container requires linking with other docker containers (such as a database backend) for complete operation. Sample [docker compose](#docker-compose) scripts are provided to get you up and running
!!! warning "Check the version"
Please make sure you are reading the [STABLE](https://docs.inventree.org/en/stable/start/docker_prod/) documentation when using the stable docker image tags.
!!! warning "Assumed Knowledge" !!! warning "Assumed Knowledge"
A very basic understanding of [Docker](https://www.docker.com/) and [docker compose](https://docs.docker.com/compose/) is assumed, for the following setup guides. A very basic understanding of [Docker](https://www.docker.com/) and [docker compose](https://docs.docker.com/compose/) is assumed, for the following setup guides.
@ -18,11 +22,11 @@ The InvenTree docker image contains all the required system packages, python mod
Pre-built Docker images are available from [dockerhub](https://hub.docker.com/r/inventree/inventree) with the following tags: Pre-built Docker images are available from [dockerhub](https://hub.docker.com/r/inventree/inventree) with the following tags:
| Tag | Description | | Tag | Description | Relevant documentation to follow |
| --- | --- | | --- | --- | --- |
| **inventree:stable** | The most recent *stable* release version of InvenTree | | **inventree:stable** | The most recent *stable* release version of InvenTree | [stable docs](https://docs.inventree.org/en/stable/start/docker/) |
| **inventree:latest** | The most up-to-date *development* version of InvenTree. | | **inventree:latest** | The most up-to-date *development* version of InvenTree. | [latest docs](https://docs.inventree.org/en/latest/start/docker/) |
| **inventree:_tag_** | Specific tagged images are built for each tagged release of InvenTree, e.g. `inventree:0.7.3`| | **inventree:_tag_** | Specific tagged images are built for each tagged release of InvenTree, e.g. `inventree:0.7.3`| https://docs.inventree.org/en/INSERT_YOUR_TAG_HERE/start/docker/ |
### Docker Compose ### Docker Compose

3
docs/docs/start/docker_prod.md
View File

@ -11,6 +11,9 @@ The following guide provides a streamlined production InvenTree installation, wi
### Before You Start ### Before You Start
!!! warning "Check the version"
Please make sure you are reading the [STABLE](https://docs.inventree.org/en/stable/start/docker_prod/) documentation when using the stable docker image tags.
!!! warning "Docker Skills Required" !!! warning "Docker Skills Required"
This guide assumes that you are reasonably comfortable with the basic concepts of docker and docker compose. This guide assumes that you are reasonably comfortable with the basic concepts of docker and docker compose.