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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#26,599 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
66/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown
Área
documentation

Línea de trabajo

Empieza por content/manuals/build/cache/backends/_index.md y compara después las etiquetas de estado de S3 y Azure Blob con s3.md y azblob.md del mismo directorio. Comprueba el estado de la función con las pruebas de la documentación y luego haz que la descripción general y las páginas individuales sean coherentes; el trabajo estará terminado cuando los lectores puedan saber si ambos backends están disponibles o son experimentales.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Markdown
Estrellas
4.7k
Forks
8.5k
Merge medio
2 d 11 h
PR fusionados (30 d)
135

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de docker/docs

Todos los issues de docker/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.