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

未關閉 適合新手
#26,599 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

@himanchalkaushale 已經在處理了。

開始於 2026年11月10日。

  • #26602 來自 @himanchalkaushale —— 未關閉
  • #26604 來自 @dave123981 —— 未關閉

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
66/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
markdown
領域
documentation

研究方向

從 content/manuals/build/cache/backends/_index.md 開始,接著將 S3 和 Azure Blob 的狀態標籤與同一目錄中的 s3.md 和 azblob.md 比較。根據文件證據核對功能狀態,然後讓總覽頁和個別頁面保持一致;讀者能判斷兩個後端是否可用或仍處於實驗階段時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

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

主要語言
Markdown
星號
4.7k
分支
8.5k
平均合併
2 天 11 小時
30 天內合併 PR
135

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

docker/docs 的其他 Issue

查看 docker/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。