[Docs] Improve jobs group docs#8688
Conversation
Add a clear overview section at the beginning of the Job Groups docs that highlights key features and benefits: - Parallel execution of multiple tasks - Heterogeneous resources per task - Independent environment setup - Automatic service discovery - Independent recovery from preemptions - Lifecycle management with primary/auxiliary tasks - Unified management through single job ID Also adds guidance on when to use Job Groups vs distributed jobs or pipelines.
Add a screenshot showing a Job Group with 4 tasks running in the SkyPilot dashboard, providing an immediate visual example of the feature.
Summary of ChangesHello @Michaelvll, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on improving the documentation for "Job Groups" by adding more detailed explanations, a visual example, and clearer guidance on their application. The changes aim to enhance user understanding of this experimental feature, outlining its core capabilities and distinguishing it from other job types within the system. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation for Job Groups by adding a clear overview, key features, and usage guidance. The new structure is much more user-friendly.
I've found one point in the documentation that seems to be outdated. The "Automatic service discovery" feature is described as being limited to Kubernetes, but the implementation appears to support other clouds as well. I've left a specific comment on this.
Overall, these are great improvements to the documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/build-docs |
|
❌ Failed to trigger ReadTheDocs build for branch |
|
❌ Failed to trigger ReadTheDocs build for branch |
concretevitamin
left a comment
There was a problem hiding this comment.
Does https://docs.skypilot.co/en/claude-add-job-groups-overview-9o38c/examples/job-groups.html#examples already include all the detailed examples in the Github repo?
Co-authored-by: Zongheng Yang <zongheng.y@gmail.com>
Tested (run the relevant ones):
bash format.sh/smoke-test(CI) orpytest tests/test_smoke.py(local)/smoke-test -k test_name(CI) orpytest tests/test_smoke.py::test_name(local)/quicktest-core(CI) orpytest tests/smoke_tests/test_backward_compat.py(local)