Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs: document workspace and provider label capabilities

Open Beginner friendly
  • Is something wrong?
#4,250 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@johntmyers is already working on this.

Since Oct 6, 2026.

  • #4265 by @johntmyers — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Update the workspace and provider documentation so they match current CLI and public protobuf contracts. Cover workspace creation with repeated --label KEY=VALUE, listing with --label-selector, workspace get display, and that there is no label update. For providers, document provider.metadata.labels on API create, that labels appear in structured output, and that the CLI has no provider label flag and ListProviders has no selector. Follow existing sandbox label examples; skip internal service-endpoint labels. Done when the DoD checkboxes hold and docs validation plus formatting checks pass.

Written by the indexing model from the issue text.

Description

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.
Dominant language
Rust
Stars
13.2k
Forks
1.6k
Avg merge
1d 19h
Merged PRs (30d)
343

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NVIDIA/OpenShell

All issues in NVIDIA/OpenShell

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.