Skip to content

docs(client): Add comprehensive docs for Engine Pool feature #7118

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 7 commits into from
Closed

docs(client): Add comprehensive docs for Engine Pool feature #7118

wants to merge 7 commits into from

Conversation

z1131392774
Copy link
Contributor

@z1131392774 z1131392774 commented Jun 27, 2025 •
edited
Loading

Adds documentation for the Engine Pool feature to the Share Level Of Kyuubi Engines page. The separate and now-redundant engine_pool.rst file has been deleted.

Why are the changes needed?

The Share Level Of Kyuubi Engines documentation previously lacked a section on the Engine Pool feature.

How was this patch tested?

Was this patch authored or co-authored using generative AI tooling?

Yes. Generative AI tools were used in several stages of preparing this contribution:

  • The initial draft of the documentation was written with the assistance of Claude.
  • Revisions and suggestions were provided by Gemini.
  • Commit messages and pull request descriptions were refined for clarity using Gemini.

Generated-by: Claude 4, Gemini 2.5 pro

@z1131392774
docs(client): Add comprehensive docs for Engine Pool feature
9ed2e8a 
The documentation for the Engine Pool feature was previously missing. This commit introduces a complete guide to help users understand, configure, and use this feature effectively.

This new document (`engine_pool.md`) covers:
- An overview of the feature's purpose and mechanism.
- Detailed descriptions of all configuration parameters (e.g., `kyuubi.engine.pool.size`).
- Clarification on configuration precedence.
- Step-by-step instructions and practical examples for setup.

Additionally, the file format has been updated from `.rst` to Markdown (`.md`) for consistency with other project documentation.
@github-actions github-actions bot added the kind:documentation Documentation is a feature! label Jun 27, 2025
@pan3793 pan3793 requested a review from yaooqinn July 2, 2025 10:10
@pan3793
Copy link
Member

pan3793 commented Jul 2, 2025

I suggest embedding the engine pool description into the existing Engine Share Level page since engine pool is one specific case of the subdomain utilization

@pan3793
Copy link
Member

pan3793 commented Jul 2, 2025

An additional comment about AI-generated comments/articles, I'm not against that, but it's usually too wordy for technical docs, please keep the words short and clear.

@z1131392774
Copy link
Contributor Author

An additional comment about AI-generated comments/articles, I'm not against that, but it's usually too wordy for technical docs, please keep the words short and clear.

Thanks for the great suggestions. That makes total sense.

I'll embed the content into the existing page and make the wording more concise. Will push the update shortly.

@codecov-commenter
Copy link

codecov-commenter commented Jul 2, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (364f062) to head (61892a2).
Report is 13 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #7118    +/-   ##
=======================================
  Coverage    0.00%   0.00%            
=======================================
  Files         697     700     +3     
  Lines       43214   43377   +163     
  Branches     5855    5875    +20     
=======================================
- Misses      43214   43377   +163

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pan3793
Copy link
Member

pan3793 commented Jul 8, 2025

@z1131392774 could you restore unnecessary style changes? the rest change LTGM.

@pan3793 pan3793 added this to the v1.11.0 milestone Jul 9, 2025
@pan3793
Copy link
Member

pan3793 commented Jul 9, 2025

@z1131392774 almost there! could you update the PR description?

@z1131392774
Copy link
Contributor Author

@pan3793 Sure. I have updated the description. Please take a look when you have a moment. Thanks!

@pan3793 pan3793 closed this in 70a2451 Jul 9, 2025
@pan3793
Copy link
Member

pan3793 commented Jul 9, 2025

Thanks, merged to master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yaooqinn yaooqinn yaooqinn approved these changes

@pan3793 pan3793 pan3793 approved these changes

Assignees

@z1131392774 z1131392774

Labels
kind:documentation Documentation is a feature!
Projects
None yet
Milestone
v1.11.0
Development

Successfully merging this pull request may close these issues.
4 participants
@z1131392774 @pan3793 @codecov-commenter @yaooqinn