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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#26,599 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é
2/5
Temps estimé
1-3 heures
Accessibilité débutants
66/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
markdown
Domaine
documentation

Piste de recherche

Commencez par content/manuals/build/cache/backends/_index.md, puis comparez les libellés d’état de S3 et Azure Blob avec s3.md et azblob.md dans le même répertoire. Vérifiez le statut de la fonctionnalité à partir des éléments de preuve de la documentation, puis harmonisez la vue d’ensemble et les pages individuelles ; le travail est terminé lorsque les lecteurs peuvent déterminer si les deux backends sont disponibles ou expérimentaux.

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

Description

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

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.