Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Readme Documentation to Clarify the Importance of Celery Service #8558

Merged
merged 1 commit into from
Sep 21, 2024

Conversation

fchange
Copy link
Contributor

@fchange fchange commented Sep 19, 2024

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.

  • Please open an issue before creating a PR or link to an existing issue
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Description

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update, included: Dify Document
  • Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
  • Dependency upgrade

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.

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:

 - https://github.com/langgenius/dify/issues?q=%E6%8E%92%E9%98%9F%E4%B8%AD
 - https://github.com/langgenius/dify/issues?q=Queuing
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. 📚 documentation Improvements or additions to documentation labels Sep 19, 2024
Copy link

@bluishoul bluishoul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 21, 2024
@crazywoola crazywoola merged commit e75c33a into langgenius:main Sep 21, 2024
6 checks passed
hgnulb pushed a commit to hgnulb/dify that referenced this pull request Sep 26, 2024
cuiks pushed a commit to cuiks/dify that referenced this pull request Sep 26, 2024
lau-td pushed a commit to heydevs-io/dify that referenced this pull request Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants