docs(load-testing): replace nonexistent `nvcf-cli registry list` and fix tip syntax
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
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
- All three pages say: "To check which registries your cluster recognises, run
./nvcf-cli registry list." nvcf-cli has noregistrycommand. The command group
isregistry-credential(src/clis/nvcf-cli/cmd/registry.go,Use: "registry-credential",
no aliases), and the subcommand for recognized registries islist-recognized. http-load-testing.mdwrites 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.goon main: the group isregistry-credentialwith subcommands
list,add,get,update,delete,list-recognized, and noAliases. - 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
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di NVIDIA/nvcf
-
cicd needs-triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 91/100
-
documentation needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
nvca operator: an invalid NVCFWorkerDegradationPeriodMinutes value blocks all cluster configuration updatesForse già presa @SelvanayakiGurusamy l’ha presa 2 giorni fa. Apertacompute-stack
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
observability: make the collector replica count configurableForse già presa @sunilthorat09 l’ha presa 2 giorni fa. Apertainfrastructure
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
documentation needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
kind/cleanup
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
kubernetes-sigs/kueue#19255 ·
I maintainer di solito rispondono entro 1 giorno