Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

docs: document workspace and provider label capabilities

Aberta Para iniciantes
  • Algo errado?
#4,250 2 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@johntmyers já está trabalhando nisso.

Desde 6/10/2026.

  • #4265 de @johntmyers — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
rust
Domínio
documentation

Direção de pesquisa

Atualize a documentação de workspace e provider para que corresponda aos contratos atuais de CLI e protobuf público. Cubra a criação de workspace com --label KEY=VALUE repetido, a listagem com --label-selector, a exibição de workspace get e o fato de que não há atualização de rótulos. Para provedores, documente provider.metadata.labels na criação de API, que os rótulos aparecem na saída estruturada e que a CLI não tem flag de rótulo de provedor e ListProviders não tem seletor. Siga os exemplos existentes de rótulos de sandbox; pule os rótulos de endpoint de serviço interno. Concluído quando as caixas de verificação da DoD estiverem marcadas e as validações de documentação e verificações de formatação forem aprovadas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.
Linguagem predominante
Rust
Estrelas
15.4k
Forks
1.7k
Merge médio
1d 20h
PRs com merge (30d)
348

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de NVIDIA/OpenShell

Todas as issues de NVIDIA/OpenShell

Issues semelhantes

Mais issues de Rust

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.