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
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
bmander/geomsolver#118 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
Three Windows builds are keyed on a later release than their layout可能已有人在做 @ero-qt 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复
-
priority:P3 type:docs
难度 2/5 1-3 小时 新手友好度 85/100
sebastian-software/ferroni#253 ·
维护者通常 1 天内回复