[docs-scanner] S3 and Azure Blob cache backends marked as unreleased but have complete documentation
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 66/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- markdown
調査の方向性
まず 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)":
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時間
- マージ済み PR(30日)
- 135
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
難易度 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
-
area/access-management Frontend onboarding candidate :handshake:
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
Altinn/altinn-auth#4941 ·
メンテナーはふだん 1 日以内に返信
-
hermes-queue
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
chrisalunlloyd2-sudo/mindpalace#373 ·
メンテナーはふだん 1 日以内に返信
-
Перевод устарел
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
ACK_WAITING HELP_WANTED UPDATE_CS
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
OWASP/CheatSheetSeries#2935 ·
メンテナーはふだん 1 日以内に返信