Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

docs: document workspace and provider label capabilities

Aperta Adatta ai principianti
  • Qualcosa non va?
#4,250 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@johntmyers ci sta già lavorando.

Dal 6/10/2026.

  • #4265 di @johntmyers — aperta

Valutazione

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

Direzione di ricerca

Aggiorna la documentazione di workspace e provider in modo che corrisponda ai contratti CLI attuali e ai contratti protobuf pubblici. Copri la creazione di workspace con --label KEY=VALUE ripetuto, l'elenco con --label-selector, la visualizzazione di workspace get e il fatto che non esiste aggiornamento delle etichette. Per i provider, documenta provider.metadata.labels nella creazione API, che le etichette appaiono nell'output strutturato e che la CLI non ha un flag per le etichette di provider e ListProviders non ha un selettore. Segui gli esempi esistenti di etichette sandbox; salta le etichette di endpoint di servizio interno. Fatto quando le caselle di controllo della DoD sono spuntate e i controlli di validazione della documentazione e di formattazione sono superati.

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

Descrizione

area:docs

User Story

When consulting OpenShell documentation to understand which objects support labels, I found that workspace labels are missing and provider label authoring is unexplained. I need documented examples and API limitations so I can use the existing label support without reading implementation code.

Description

Document the existing label capabilities for workspaces and providers. Add workspace creation, inspection, and selector examples. Explain how API clients set provider labels and clarify the CLI and filtering limitations.

Context

  • Workspace creation accepts repeated --label KEY=VALUE; listing accepts --label-selector key=value,key2=value2; workspace get displays labels.
  • Provider creation accepts provider.metadata.labels through the API and persists them. The provider docs mention labels in structured output but do not explain authoring. The CLI has no provider label flag and ListProviders has no label selector.
  • Sandbox and sandbox workload template labels already have documented examples.
  • Internal labels on service endpoints are outside this task's scope.

Definition of Done

  • Workspace docs explain creation, inspection, filtering, and the absence of a label update operation.
  • Provider docs show the label field used by API creation and clarify CLI/filtering limitations.
  • Examples match current CLI and public protobuf contracts.
  • Documentation validation and applicable formatting checks pass.
Lingua principale
Rust
Stelle
13.2k
Fork
1.6k
Merge medio
1g 20h
PR unite (30g)
348

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/OpenShell

Tutte le issue di NVIDIA/OpenShell

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.