Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docs: document workspace and provider label capabilities

Abierto Apto para principiantes
  • ¿Algo no está bien?
#4,250 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@johntmyers ya está trabajando en esto.

Desde el 6/10/2026.

  • #4265 de @johntmyers — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
rust
Área
documentation

Línea de trabajo

Actualiza la documentación de workspace y provider para que coincida con los contratos actuales de CLI y protobuf público. Cubre la creación de workspace con --label KEY=VALUE repetido, el listado con --label-selector, la visualización de workspace get y que no existe actualización de etiquetas. Para proveedores, documenta provider.metadata.labels en la creación de API, que las etiquetas aparecen en la salida estructurada y que la CLI no tiene flag de etiqueta de proveedor y ListProviders no tiene selector. Sigue los ejemplos existentes de etiquetas de sandbox; omite las etiquetas de endpoint de servicio interno. Hecho cuando las casillas de verificación de DoD estén marcadas y pasen las validaciones de documentación y las comprobaciones de formato.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Rust
Estrellas
13.2k
Forks
1.6k
Merge medio
1 d 20 h
PR fusionados (30 d)
348

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NVIDIA/OpenShell

Todos los issues de NVIDIA/OpenShell

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.