Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: document workspace and provider label capabilities

オープン 初心者向け
#4,250 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@johntmyers がすでに取り組んでいます。

2026年10月6日 から。

  • #4265 @johntmyers による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
rust
領域
documentation

調査の方向性

ワークスペースとプロバイダーのドキュメントを更新し、現在のCLIおよび公開プロトコルバッファのコントラクトと一致するようにしてください。繰り返し--label KEY=VALUEを使用したワークスペースの作成、--label-selectorを使用した一覧表示、workspace getの表示、ラベルの更新が存在しないことをカバーしてください。プロバイダーについては、API作成時のprovider.metadata.labels、ラベルが構造化出力に表示されること、CLIにプロバイダーラベルフラグがなくListProvidersにセレクタがないことを文書化してください。既存のサンドボックスラベルの例に従ってください。内部サービスエンドポイントラベルはスキップしてください。DoDチェックボックスがすべてチェックされ、ドキュメント検証とフォーマットチェックに合格したら完了です。

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Rust
スター
13.2k
フォーク
1.6k
平均マージ
1日 20時間
マージ済み PR(30日)
348

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NVIDIA/OpenShell のほかの issue

NVIDIA/OpenShell の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。