Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs: document workspace and provider label capabilities

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#4,250 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@johntmyers đang làm issue này rồi.

Từ ngày 6/10/2026.

  • #4265 của @johntmyers — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

Cập nhật tài liệu về workspace và provider để chúng khớp với các hợp đồng CLI hiện tại và hợp đồng protobuf công khai. Bao gồm tạo workspace với --label KEY=VALUE lặp lại, liệt kê với --label-selector, hiển thị của workspace get và việc không có cập nhật nhãn. Đối với provider, ghi chú provider.metadata.labels khi tạo API, rằng các nhãn xuất hiện trong đầu ra có cấu trúc và rằng CLI không có cờ nhãn provider và ListProviders không có bộ chọn. Làm theo các ví dụ nhãn sandbox hiện có; bỏ qua các nhãn endpoint dịch vụ nội bộ. Hoàn thành khi các hộp kiểm tra DoD được đánh dấu và kiểm tra xác thực tài liệu cũng như kiểm tra định dạng đều vượt qua.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Rust
Star
15.4k
Fork
1.7k
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
363

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NVIDIA/OpenShell

Tất cả issue của NVIDIA/OpenShell

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.