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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#26,600 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
95/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
docker, markdown
Domaine
documentation

Piste de recherche

Lisez content/manuals/build/cache/backends/inline.md et comparez son introduction à celles de local.md, registry.md et gha.md. Ajoutez l’exigence indiquée concernant le pilote avant la section Synopsis, en suivant ces pages ; le travail est terminé lorsque la page inline explique l’exigence relative au containerd image store et renvoie vers Build drivers.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Markdown
Étoiles
4.7k
Forks
8.5k
Merge moyen
2 j 11 h
PR mergées (30 j)
135

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de docker/docs

Toutes les issues de docker/docs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.