Update guide #4812
Update guide #4812
Conversation
site/content/en/docs/faq.md
Outdated
| Sometimes the update process takes a lot of time due to changes in the database schema and data. | ||
| You can check the current status with `docker logs cvat`. | ||
| Please do not terminate the migration and wait till the process is complete. | ||
| Floow the [update guide](/docs/administration/advanced/update_guide/). |
There was a problem hiding this comment.
@azhavoro , please check gramma
|
|
||
| ## About CVAT data volumes | ||
|
|
||
| Docker volumes are used to store all CVAT data: |
There was a problem hiding this comment.
@azhavoro , could we show how to upgrade CVAT instance from v1.7.0 to v2.1.0? I belive in examples. It is easy to follow them. We will see (at least now), that the particular example works.
There was a problem hiding this comment.
Probably for the section it doesn't make sense. Should we add it in FAQ?
| title: 'Update guide' | ||
| linkTitle: 'Update guide' | ||
| weight: 11 | ||
| description: 'Instructions for updating CVAT deployed with docker compose' |
There was a problem hiding this comment.
Let's call the process upgrade. Please rename 'update'/'updating' to 'upgrade'/'upgrading'.
| - With git: | ||
| Run the following commands inside CVAT folder | ||
| ```shell | ||
| git checkout develop |
There was a problem hiding this comment.
I would add instructions how to clone the repository.
There was a problem hiding this comment.
Probably we need a separate section in CVAT installation guide how to get CVAT source code. Thus here we can only provide a link.
| git checkout develop | ||
| git pull | ||
| ``` | ||
| Optionally checkout to specific version: |
There was a problem hiding this comment.
I'm not sure, but Optionally checkout a specific version looks better.
| - Update settings: | ||
| If `docker-compose.override.yml` configuration file is present in your installation, | ||
| check it and adjust the settings if necessary. | ||
| From time to time the installation process changes a little and |
There was a problem hiding this comment.
the installation process is changed/modified (drop a little)
| Check the [installation guide](/docs/administration/basics/installation/) for details. | ||
|
|
||
| - Update settings: | ||
| If `docker-compose.override.yml` configuration file is present in your installation, |
There was a problem hiding this comment.
Again, I would redirect the user to the installation guide (a specific section). Here we need just basic instructions, but notify users about possible problems.
| check it and adjust the settings if necessary. | ||
| From time to time the installation process changes a little and | ||
| you may need to export some environment variables, for example. | ||
| Follow the [installation guide](/docs/administration/basics/installation/). |
There was a problem hiding this comment.
It is to big. Need to point to a specific section. If it doesn't exist, I will recommend to add it.
| you may need to export some environment variables, for example. | ||
| Follow the [installation guide](/docs/administration/basics/installation/). | ||
|
|
||
| - Update local CVAT images. Two option here: |
There was a problem hiding this comment.
Again, the process should be described somewhere in installation guide. Here we need to add a link and provide some basic instructions. For example, for v2.1.0
|
@azhavoro , the primiary idea of my comments is the following:
It will help us to keep instructions mostly in one document. All other guides should show only basic steps. They should be simple. If users need more details, they need to read the primary installation guide. |
Motivation and context
Add more detailed CVAT update guide than now.
Also, resolve #4598
How has this been tested?
Manually
Checklist
developbranchcvat-core, cvat-data and cvat-ui)
License
Feel free to contact the maintainers if that's a concern.