[docs-scanner] S3 and Azure Blob cache backends marked as unreleased but have complete documentation

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#26,599 0 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

Chưa có ai nhận issue này.

Đá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
66/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với content/manuals/build/cache/backends/_index.md, sau đó so sánh nhãn trạng thái S3 và Azure Blob với s3.md và azblob.md trong cùng thư mục. Đối chiếu trạng thái tính năng với bằng chứng trong tài liệu, rồi đảm bảo trang tổng quan và các trang riêng lẻ nhất quán; hoàn tất khi người đọc có thể biết cả hai backend hiện khả dụng hay đang ở trạng thái thử nghiệm.

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

Mô tả

File: content/manuals/build/cache/backends/_index.md

Issue

The main cache backends overview page marks S3 and Azure Blob Storage as "(unreleased)":

However, both s3.md and azblob.md in the same directory contain complete, production-ready documentation with:

  • Full synopsis and usage examples
  • Complete parameter tables
  • Authentication instructions
  • Summary bars indicating feature status (not unreleased status)
Why this matters

Readers see "(unreleased)" on the overview page and may assume these features aren't available yet, when in fact they have complete documentation suggesting they are released features. This creates confusion about whether users can actually use these cache backends.

Suggested fix

Either:

  1. Remove the "(unreleased)" designation if these features are actually released and available
  2. Or, if they truly are unreleased/experimental, add clear experimental/beta warnings to the individual documentation pages and explain what "unreleased" means (e.g., "available in BuildKit but not yet in stable Docker release")

The individual pages should match the status indicated in the overview.

Found by nightly documentation quality scanner

Ngôn ngữ chính
Markdown
Star
4.7k
Fork
8.5k
Merge trung bình
2 ngày 11 giờ
Pull request đã merge (30 ngày)
135

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 docker/docs

Tất cả issue của docker/docs

Issue tương tự

Thêm issue về Documentation

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.