Enhance Readme Documentation to Clarify the Importance of Celery Service #8558
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Key Improvements:
Clearly state the necessity of the Celery service and its role in task scheduling. Provide clear startup guidelines and configuration suggestions to help users avoid common configuration errors. We believe these enhancements will greatly improve the readability and practicality of the documentation, ensuring that users can smoothly start and utilize the Celery service.
Associated Issues:
Checklist:
Important
Please review the checklist below before submitting your pull request.
dev/reformat
(backend) andcd web && npx lint-staged
(frontend) to appease the lint godsDescription
Upon reviewing user feedback, we've identified that certain statements in the Readme documentation might be misleading, causing many users to fail in properly initiating the Celery application. This not only impacts the efficiency of task execution but can also lead to prolonged task blocking. To address this issue, we have revised the relevant prompts in the Readme documentation to ensure that users fully comprehend the significance of the Celery service and can configure and launch it correctly.
Fixes
Type of Change