[docs-scanner] S3 and Azure Blob cache backends marked as unreleased but have complete documentation
維護者通常 1 天內回覆
@himanchalkaushale 已經在處理了。
開始於 2026年11月10日。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 66/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 活躍
- 技術堆疊
- markdown
研究方向
從 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)":
s3: uploads the build cache to an
AWS S3 bucket (unreleased).
azblob: uploads the build cache to
Azure Blob Storage
(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:
- Remove the "(unreleased)" designation if these features are actually released and available
- 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
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
docker/docs 的其他 Issue
-
[docs-scanner] Inline cache missing driver/containerd requirement that overview page states可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉
難度 1/5 1 小時以內 新手友好度 95/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 84/100
維護者通常 1 天內回覆
-
status/triage
難度 1/5 1 小時以內 新手友好度 92/100
維護者通常 1 天內回覆
-
[docs-scanner] Confusing explanation of approval-required outcome vs permit in MCP policy可能已有人在做 @dave123981 於 3 天前認領。 未關閉
難度 1/5 1 小時以內 新手友好度 88/100
維護者通常 1 天內回覆
-
[docs-scanner] Contradictory information about MCP approval fields in audit records可能已有人在做 @dave123981 於 3 天前認領。 未關閉
難度 1/5 1-3 小時 新手友好度 88/100
維護者通常 1 天內回覆
相似的 Issue
-
help wanted new command
難度 2/5 1-3 小時 新手友好度 76/100
tldr-pages/tldr#25111 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 67/100
code-yeongyu/senpi#6375 ·
維護者通常 1 天內回覆
-
documentation
難度 1/5 1-3 小時 新手友好度 83/100
MysterionRise/pubchem-finder#108 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
ktwu01/benchmark-radar#1220 ·
維護者通常 1 天內回覆
-
enhancement good first issue
難度 1/5 1 小時以內 新手友好度 98/100