Skip to content

Fix network-topology guide range rendering and wording across EN/ZH current + versioned docs - #555

Merged
volcano-sh-bot merged 2 commits into
masterfrom
copilot/fix-network-topology-user-guide
Jul 30, 2026
Merged

Fix network-topology guide range rendering and wording across EN/ZH current + versioned docs#555
volcano-sh-bot merged 2 commits into
masterfrom
copilot/fix-network-topology-user-guide

Conversation

Copilot AI commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The network-topology user guide used raw ~ range notation, which can render as Markdown strikethrough, and the affected paragraph also had English grammar/clarity issues. This updates that passage consistently in English and Simplified Chinese across current and versioned documentation.

  • Scope of updates

    • Updated the same paragraph in:
      • docs/UserGuide/...network_topology_aware_scheduling.md
      • versioned_docs/version-v1.13.0/...
      • versioned_docs/version-v1.14.0/...
      • versioned_docs/version-v1.15.0/...
      • i18n/zh-Hans/docusaurus-plugin-content-docs/current/...
      • i18n/zh-Hans/docusaurus-plugin-content-docs/version-v1.13.0/...
      • i18n/zh-Hans/docusaurus-plugin-content-docs/version-v1.14.0/...
      • i18n/zh-Hans/docusaurus-plugin-content-docs/version-v1.15.0/...
  • Rendering fix

    • Replaced raw ~ ranges with en-dash ranges in the target passage (e.g., Node0–Node7, Pod0–Pod3) to prevent strikethrough interpretation.
  • Wording/grammar improvements

    • Corrected English grammar (the second partition ... is).
    • Rewrote EN/ZH paragraph for parallel structure and clearer placement semantics while preserving technical meaning:
      • whole Job in HyperNode2 / nodes Node0–Node7
      • partition 1 (Pods Pod0–Pod3) in HyperNode0 / nodes Node0–Node3
      • partition 2 (Pods Pod4–Pod7) in HyperNode1 / nodes Node4–Node7
      • each partition satisfies its topology constraints
In this example, the entire Job is scheduled within HyperNode2 (nodes Node0–Node7). The first partition, Pods Pod0–Pod3, is scheduled within HyperNode0 (nodes Node0–Node3). The second partition, Pods Pod4–Pod7, is scheduled within HyperNode1 (nodes Node4–Node7). Each partition satisfies its own network topology constraints.

@volcano-sh-bot volcano-sh-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 29, 2026
@volcano-sh-bot volcano-sh-bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 29, 2026
Copilot AI changed the title [WIP] Fix incorrect strikethrough in network topology user guide Fix network-topology guide range rendering and wording across EN/ZH current + versioned docs Jul 29, 2026
Copilot AI requested a review from JesseStutler July 29, 2026 10:05
@JesseStutler
JesseStutler marked this pull request as ready for review July 30, 2026 01:16
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@volcano-sh-bot volcano-sh-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 30, 2026
@JesseStutler

Copy link
Copy Markdown
Member

/approve
/lgtm
Thanks

@volcano-sh-bot volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 30, 2026
@volcano-sh-bot

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JesseStutler

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

The pull request process is described 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 volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 30, 2026
@volcano-sh-bot
volcano-sh-bot merged commit ff9a82e into master Jul 30, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants