Skip to content

docs: document the cmd/ binaries with no user-facing guide #697

Description

@ArangoGutierrez

cmd/ ships ten binaries. Only nvml-mock-ctl has a documentation page.

Undocumented: mokka-control-plane, nvml-mock-nri, mock-ib,
fake-fabricmanager, fake-imex, check-fabric, generate-bridge,
imex-nogpu-shim, render-imex-procdevices, render-pci-sysfs.

Now that the documentation is published at
https://nvidia.github.io/k8s-test-infra/ the gap is user-visible rather than an
internal inconsistency. mokka-control-plane is likely the highest value given
it is the newest surface.

Adding a page means creating docs/<name>.md and a nav entry in mkdocs.yml.
make docs fails on a broken link or a nav entry pointing at a missing file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority/p2P2: minor defect or perf implication. No fix-time commitment.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions