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

オープン 初心者向け
#26,599 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
66/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
markdown
領域
documentation

調査の方向性

まず content/manuals/build/cache/backends/_index.md を確認し、同じディレクトリにある s3.md と azblob.md の S3 および Azure Blob のステータスラベルと比較してください。ドキュメントの根拠に照らして機能のステータスを確認し、概要ページと個別ページの内容を一致させてください。両方のバックエンドが利用可能か実験的かを読者が判断できれば完了です。

索引モデルが 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時間
マージ済み PR(30日)
135

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

docker/docs のほかの issue

docker/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。