Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

docs: document workspace and provider label capabilities

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#4,250 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@johntmyers arbeitet bereits daran.

Seit 06.10.2026.

  • #4265 von @johntmyers — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
rust
Bereich
documentation

Rechercherichtung

Aktualisiere die Workspace- und Provider-Dokumentation, sodass sie mit den aktuellen CLI- und öffentlichen Protobuf-Verträgen übereinstimmt. Behandle die Workspace-Erstellung mit wiederholtem --label KEY=VALUE, die Auflistung mit --label-selector, die Anzeige von workspace get und die Tatsache, dass es keine Label-Aktualisierung gibt. Für Provider dokumentiere provider.metadata.labels bei API-Erstellung, dass Labels in strukturierter Ausgabe erscheinen und dass die CLI kein Provider-Label-Flag hat und ListProviders keinen Selektor hat. Folge den vorhandenen Sandbox-Label-Beispielen; überspringe interne Service-Endpunkt-Labels. Fertig, wenn die DoD-Checkboxen gesetzt sind, die Dokumentenvalidierung und Formatierungsprüfungen bestanden sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
Rust
Sterne
13.2k
Forks
1.6k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
343

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus NVIDIA/OpenShell

Alle Issues in NVIDIA/OpenShell

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.