Updated documentation: need to mount shared volume to cvat_worker_chunks

[bsekachev]

Motivation and context

Related #8803

How has this been tested?

Checklist

• I submit my changes into the develop branch
• I have created a changelog fragment
• I have updated the documentation accordingly
• I have added tests to cover my changes
• I have linked related issues (see GitHub docs)
• I have increased versions of npm packages if it is necessary
  (cvat-canvas,
  cvat-core,
  cvat-data and
  cvat-ui)

License

• I submit my code changes under the same MIT License that covers the project.
  Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

• New Features

  • Added a section in the FAQ for configuring a connected share folder on Windows.
  • Introduced a new volume entry for cvat_worker_chunks in the installation documentation and FAQ.

• Bug Fixes

  • Improved clarity and corrected grammatical errors in the installation instructions.

• Documentation

  • Streamlined installation steps for Google Chrome.
  • Expanded troubleshooting section for users in China with alternative package management sources.
  • Clarified storage locations for uploaded images/videos and annotations.

[coderabbitai]

Walkthrough

The changes made in this pull request involve updates to the installation and FAQ documentation for CVAT. The installation.md file has been revised for clarity, correcting grammatical errors and expanding troubleshooting guidance, particularly for users in China. A new volume entry for cvat_worker_chunks has been added to the Docker configuration. The FAQ document now includes a section on configuring shared folders on Windows, along with clarifications on data storage locations. These modifications aim to enhance the usability and comprehensiveness of the documentation.

Changes

File Path	Change Summary
site/content/en/docs/administration/basics/installation.md	Improved clarity and correctness in installation instructions, added cvat_worker_chunks volume entry, streamlined Chrome installation steps, clarified proxy deployment, expanded troubleshooting for users in China, and specified health check command.
site/content/en/docs/faq.md	Added new section on configuring connected share folder on Windows, provided YAML examples for docker-compose.yml, clarified storage locations for uploaded images/videos and annotations.

Poem

In the land of code where rabbits play,
We’ve polished the docs in a bright new way.
With chunks for sharing and tips for all,
Our CVAT guide stands proud and tall.
Hop along, dear users, to install with glee,
For clarity and help are now the key! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 17016de and a2eabba.

📒 Files selected for processing (2)

• site/content/en/docs/administration/basics/installation.md (2 hunks)
• site/content/en/docs/faq.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

site/content/en/docs/administration/basics/installation.md

[style] ~463-~463: Consider a more expressive alternative.
Context: ...loading data when you create a task. To do that, you need to mount the shared stor...

(DO_ACHIEVE)

🔇 Additional comments (3)

site/content/en/docs/faq.md (1)

87-89: LGTM: Consistent volume configuration for cvat_worker_chunks

The addition of cvat_worker_chunks service to the shared volume configuration follows the same pattern as other services and is properly documented.

site/content/en/docs/administration/basics/installation.md (2)

463-463: LGTM: Improved clarity in documentation

The text change improves readability while maintaining technical accuracy.

🧰 Tools

🪛 LanguageTool

[style] ~463-~463: Consider a more expressive alternative.
Context: ...loading data when you create a task. To do that, you need to mount the shared stor...

(DO_ACHIEVE)

---

480-482: LGTM: Consistent shared storage configuration

The addition of cvat_worker_chunks service to the shared storage configuration is consistent with the FAQ documentation and follows the established pattern.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud