Skip to content

zh developers/protocol.md describes a different protocol than the english source #542

Description

@mesutoezdil

The current english docs/developers/protocol.md describes device registration using node-handshake and node-register annotations:

hami.io/node-handshake-{device-type}
hami.io/node-{device-type}-register

The zh translation (i18n/zh/docusaurus-plugin-content-docs/current/developers/protocol.md) describes a different scheme with bind-time and vgpu-devices annotations:

hami.io/bind-time
hami.io/vgpu-devices-allocated
hami.io/vgpu-devices-to-allocate

It also references different diagram images (device-registration.png, task-dispatch.png vs the english protocol-register.png) and has an extra section, Scheduling Decision, that the english version does not have.

Same mismatch exists in the versioned snapshots for v2.7.0 and v2.8.0 (i18n/zh/docusaurus-plugin-content-docs/version-v2.7.0/developers/protocol.md and version-v2.8.0/developers/protocol.md), where the zh file also ends in a truncated, unclosed code fence.

I do not know which scheme is the one actually implemented in HAMi today, so I cannot safely fix the translation myself. Someone with knowledge of the current protocol design should confirm which scheme is correct and rewrite the zh file to match.

Files:

  • docs/developers/protocol.md (english source)
  • i18n/zh/docusaurus-plugin-content-docs/current/developers/protocol.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.7.0/developers/protocol.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/developers/protocol.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions