Skip to content

#475 Add HyperJob in both EN and CN language#516

Open
safiya2610 wants to merge 1 commit into
volcano-sh:masterfrom
safiya2610:add-hyperjob-docs
Open

#475 Add HyperJob in both EN and CN language#516
safiya2610 wants to merge 1 commit into
volcano-sh:masterfrom
safiya2610:add-hyperjob-docs

Conversation

@safiya2610

@safiya2610 safiya2610 commented Jun 3, 2026

Copy link
Copy Markdown

What kind of change does this PR introduce?

/kind documentation

What this PR does / why we need it

This PR adds comprehensive documentation for the HyperJob for Multi-cluster Job Splitting feature in Volcano.

This PR introduces:

  • English Documentation: docs/Concepts/HyperJob.md
  • Chinese Translation: i18n/zh-Hans/docusaurus-plugin-content-docs/current/Concepts/HyperJob.md

Both documents include the Introduction, Architecture Motivation, YAML Examples, Key Fields (Spec, ReplicatedJob, SplitPolicy), Status tracking, Usage matrices, and Multi-cluster limitations notes.

Which issue(s) this PR fixes

Closes #475

Special notes for reviewers

  • The Chinese translation documentation has been placed directly under the current/ versioning folder to align with the latest Docusaurus documentation tracking.
  • All commits are DCO (Developer Certificate of Origin) compliant and signed-off (-s).

Test plan

  • Run npm run build to ensure no broken links or markdown compilation errors.
  • Verified localized rendering locally by running npm run start -- --locale zh-Hans to ensure the Chinese documentation paths resolve perfectly without 404 errors.

EN language

Screenshot (2917) Screenshot (2918) Screenshot (2919) Screenshot (2920) Screenshot (2921) Screenshot (2922)

CN Language

Screenshot (2928) Screenshot (2929) Screenshot (2930)

@volcano-sh-bot

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kevin-wangzefeng for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@volcano-sh-bot

Copy link
Copy Markdown
Collaborator

Welcome @safiya2610! It looks like this is your first PR to volcano-sh/website 🎉

@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 3, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces documentation for HyperJob, a high-level orchestration abstraction built on top of Volcano Job, in both English and Simplified Chinese. The feedback highlights an issue in both files where markdown link syntax is incorrectly used inside YAML code blocks for resource keys (e.g., huawei.com/ascend910b and huawei.com/ascend910c), which renders the YAML invalid and should be replaced with plain text.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/Concepts/HyperJob.md Outdated
Comment thread docs/Concepts/HyperJob.md Outdated
Comment thread i18n/zh-Hans/docusaurus-plugin-content-docs/current/Concepts/HyperJob.md Outdated
Comment thread i18n/zh-Hans/docusaurus-plugin-content-docs/current/Concepts/HyperJob.md Outdated
@volcano-sh-bot volcano-sh-bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jun 3, 2026
@safiya2610 safiya2610 changed the title Add HyperJob in both EN and CN language #475 Add HyperJob in both EN and CN language Jun 3, 2026
@safiya2610 safiya2610 force-pushed the add-hyperjob-docs branch from 5c3f519 to 3e8c1ab Compare June 3, 2026 14:12
@volcano-sh-bot volcano-sh-bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jun 3, 2026
@safiya2610

Copy link
Copy Markdown
Author

@JesseStutler Please review the PR.

@safiya2610 safiya2610 force-pushed the add-hyperjob-docs branch from 3e8c1ab to 5a5f00b Compare June 4, 2026 04:45
Comment thread docs/Concepts/HyperJob.md Outdated
image: training-image:v1
resources:
requests:
[huawei.com/ascend910b](https://huawei.com/ascend910b): 1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why the requests format look like this?

@safiya2610 safiya2610 Jun 12, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I fix the example. and taken from here:
image

@JesseStutler

Copy link
Copy Markdown
Member

Thank you, could you also archive it into v1.15/v1.14? Current the website has been updated

@safiya2610

safiya2610 commented Jun 12, 2026

Copy link
Copy Markdown
Author

Thank you, could you also archive it into v1.15/v1.14? Current the website has been updated

surely,I will do it.

@volcano-sh-bot volcano-sh-bot added do-not-merge/contains-merge-commits size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 12, 2026
@safiya2610

Copy link
Copy Markdown
Author

Thank you, could you also archive it into v1.15/v1.14? Current the website has been updated

Screenshot (3120) Screenshot (3121)

In CN Language:
Screenshot (3124)
Screenshot (3123)

@JesseStutler I have added for v1.15/v1.14, Please review.

@safiya2610 safiya2610 requested a review from JesseStutler June 14, 2026 10:59
@JesseStutler

Copy link
Copy Markdown
Member

@safiya2610 You didn't sign off your commits, please sign off and squash to one commit

@safiya2610

Copy link
Copy Markdown
Author

@safiya2610 You didn't sign off your commits, please sign off and squash to one commit

doing..

@safiya2610 safiya2610 force-pushed the add-hyperjob-docs branch 2 times, most recently from 0640ecb to 9cf85af Compare June 16, 2026 12:33
@volcano-sh-bot volcano-sh-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. do-not-merge/contains-merge-commits size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed do-not-merge/contains-merge-commits size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 16, 2026
Signed-off-by: Safiya <147792763+safiya2610@users.noreply.github.com>
@safiya2610

Copy link
Copy Markdown
Author

@safiya2610 You didn't sign off your commits, please sign off and squash to one commit

Done.

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

Labels

size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add HyperJob concept to concepts documentation (both EN and CN)

3 participants