[docs-scanner] Inline cache missing driver/containerd requirement that overview page states

オープン 初心者向け
  • 何か問題がありますか？
#26,600 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
95/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
docker, markdown
領域
documentation

調査の方向性

content/manuals/build/cache/backends/inline.mdを読み、導入部をlocal.md、registry.md、gha.mdと比較します。これらのページに合わせて、Synopsisセクションの前に指定されたドライバー要件を追加します。inlineページでcontainerd image storeの要件を説明し、Build driversへのリンクを設ければ完了です。

索引モデルが issue の本文から書いたものです。

説明

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

Issue

The cache backends overview (_index.md) states that the default docker driver supports inline cache only with containerd image store enabled:

The default docker driver supports the inline, local, registry, and
gha cache backends, but only if you have enabled the containerd image store.

However, the inline cache documentation page (inline.md) makes no mention of this requirement. In contrast, the other three backends mentioned (local.md, registry.md, and gha.md) all explicitly include this notice:

This cache storage backend works with the default docker driver only when the
containerd image store is enabled. If
the containerd image store isn't enabled, use a different driver.

Why this matters

Readers following the inline cache documentation won't know they need to enable the containerd image store to use it with the default docker driver. This creates an inconsistency across the cache backend documentation and may lead to confusion when the feature doesn't work as expected.

Suggested fix

Add the same driver requirement notice to inline.md that appears in local.md, registry.md, and gha.md:

This cache storage backend works with the default `docker` driver only when the
[containerd image store](/manuals/desktop/features/containerd.md) is enabled. If
the containerd image store isn't enabled, use a different driver. See
[Build drivers](/manuals/build/builders/drivers/_index.md) for more information.

Place this notice in the introductory section, before the Synopsis section, to match the pattern used in the other backend pages.

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 を短くまとめたダイジェスト。