[Merge when release] Update upgrade guide
#8940
Conversation
WalkthroughThe pull request introduces a new section in the CVAT upgrade guide specifically addressing post-upgrade procedures for version 2.26.0. The addition provides detailed instructions for cleaning up the export cache using the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
site/content/en/docs/administration/advanced/upgrade_guide.md (3)
59-63: Add more context about the cleanup importance.Consider adding information about:
- Whether this cleanup step is mandatory or optional
- Potential impact if the cleanup is not performed (e.g., disk space usage)
- Whether this needs to be done immediately after upgrade or can be done later
67-69: Consider making the Docker command more robust.The current Docker command might fail in non-interactive environments or if the container name is different. Consider:
- Removing the
-itflag as it's not needed for this command- Adding a note about customized container names
- docker exec -it cvat_server python manage.py cleanuplegacyexportcache + docker exec cvat_server python manage.py cleanuplegacyexportcache
74-76: Add context for development environment setup.Please specify:
- The directory from which to run the command
- Any virtual environment requirements
- Any prerequisite setup steps needed
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
site/content/en/docs/administration/advanced/upgrade_guide.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: generate_github_pages
- GitHub Check: Analyze (python)
- GitHub Check: Analyze (javascript)
- GitHub Check: Linter
🔇 Additional comments (3)
site/content/en/docs/administration/advanced/upgrade_guide.md (3)
64-67: LGTM!The tab pane setup is correct and properly handles linting.
77-80: LGTM!The tab pane is properly closed and linting controls are correctly handled.
70-73: Add handling for multiple backend pods scenario.The current command arbitrarily selects the first pod when multiple backend pods exist. Consider:
- Adding a note about this behavior
- Providing guidance for multi-pod deployments
- Suggesting running the command on all backend pods if necessary
Let's verify if the project supports multiple backend pods:
Motivation and context
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit