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

Aperta Adatta ai principianti
  • Qualcosa non va?
#26,600 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
95/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, markdown
Ambito
documentation

Direzione di ricerca

Leggi content/manuals/build/cache/backends/inline.md e confrontane l’introduzione con quelle di local.md, registry.md e gha.md. Aggiungi il requisito indicato per il driver prima della sezione Synopsis, seguendo queste pagine; il lavoro è completato quando la pagina inline spiega il requisito del containerd image store e rimanda a Build drivers.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
2g 11h
PR unite (30g)
135

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docker/docs

Tutte le issue di docker/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.