docs(load-testing): replace nonexistent `nvcf-cli registry list` and fix tip syntax

Aperta Adatta ai principianti
#3,548 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
go, markdown
Ambito
documentation

Direzione di ricerca

Read docs/dev/http-load-testing.md, docs/dev/http-soak-testing.md, and docs/dev/grpc-load-testing.md, then check src/clis/nvcf-cli/cmd/registry.go to confirm the command name. Update each tip to use ./nvcf-cli registry-credential list-recognized and make the first page's tip match the Fern <Tip> syntax used by the other two. Done when all three pages show the recognized-registry command and use consistent tip syntax.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation needs-triage

Report incorrect documentation

Location of incorrect documentation
  • docs/dev/http-load-testing.md (tip after the image push step)
  • docs/dev/http-soak-testing.md (same tip)
  • docs/dev/grpc-load-testing.md (same tip)

The docs/overview/ versions of these pages are symlinks to these files, so fixing
them here fixes both.

Describe the problems or issues found in the documentation
  1. All three pages say: "To check which registries your cluster recognises, run
    ./nvcf-cli registry list." nvcf-cli has no registry command. The command group
    is registry-credential (src/clis/nvcf-cli/cmd/registry.go, Use: "registry-credential",
    no aliases), and the subcommand for recognized registries is list-recognized.
  2. http-load-testing.md writes this tip as a MyST directive (:::{tip} ... :::),
    while the other two pages use Fern's <Tip> component. It is the only :::{
    directive in the current docs, so it may not render as a callout on the Fern site.
Steps taken to verify documentation is incorrect
  • Read registry.go on main: the group is registry-credential with subcommands
    list, add, get, update, delete, list-recognized, and no Aliases.
  • Searched the current docs (excluding versioned archives) for :::{: only this page uses it.
Suggested fix for documentation

Replace the command with ./nvcf-cli registry-credential list-recognized on all
three pages, and change the :::{tip} block in http-load-testing.md to <Tip>
to match the other two. Optionally add registry-credential list for checking
which credentials are configured. Happy to send the PR.

Lingua principale
Go
Stelle
251
Fork
100
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NVIDIA/nvcf

Tutte le issue di NVIDIA/nvcf

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.