docs: document workspace and provider label capabilities
維護者通常 1 天內回覆
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 72/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
- 技術堆疊
- rust
研究方向
更新工作區與提供者的文件，使其與目前的 CLI 與公開 protobuf 合約一致。涵蓋使用重複的 --label KEY=VALUE 建立工作區、使用 --label-selector 列出、workspace get 的顯示，以及不存在標籤更新。對於提供者，記錄 API 建立時的 provider.metadata.labels、標籤出現在結構化輸出中，以及 CLI 沒有提供者標籤旗標且 ListProviders 沒有選擇器。遵循現有的沙盒標籤範例；跳過內部服務端點標籤。當 DoD 核取方塊全部勾選、文件驗證與格式檢查通過時即完成。
由索引模型根據 Issue 內容生成。
描述
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 getdisplays labels. - Provider creation accepts
provider.metadata.labelsthrough 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.
- 主要語言
- Rust
- 星號
- 13.2k
- 分支
- 1.6k
- 平均合併
- 1 天 20 小時
- 30 天內合併 PR
- 348
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
NVIDIA/OpenShell 的其他 Issue
-
bug(vm-driver): VM sandbox cold start stalls ~5 s repeatedly on "Waiting for VM supervisor"可能已有人在做 @benoitf 今天認領。 未關閉state:triage-needed
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
Sandbox-side proposal audit (CONFIG:PROPOSED and /wait decisions) names only the first endpoint可能已有人在做 @ericcurtin 今天認領。 未關閉state:accepted
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
bug(driver-mxc): test helper fails to compile after gateway-name argument可能已有人在做 @feloy 於 2 天前認領。 未關閉state:triage-needed
難度 1/5 1 小時以內 新手友好度 88/100
維護者通常 1 天內回覆
-
bug: install.sh ignores XDG_CONFIG_HOME for the local gateway config可能已有人在做 @fede-kamel 於 6 天前認領。 未關閉area:cli os:linux os:macos state:validated
難度 2/5 1-3 小時 新手友好度 88/100
NVIDIA/OpenShell#4042 · 2 則留言 ·
維護者通常 1 天內回覆
-
state:triage-needed
難度 2/5 1-3 小時 新手友好度 72/100
NVIDIA/OpenShell#3995 · 2 則留言 ·
維護者通常 1 天內回覆
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 95/100
維護者通常 1 天內回覆
-
Markdown Preview Fonts Don't Show Selected Option可能已有人在做 @RadhiRasho 今天認領。 未關閉state:needs triage
難度 2/5 1-3 小時 新手友好度 61/100
zed-industries/zed#65300 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
enhancement
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆