[docs-scanner] Inconsistent information about what gets deleted when Docker Offload v1 session ends

Abierto Apto para principiantes
  • ¿Algo no está bien?
#26,565 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
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Área
documentation

Línea de trabajo

Lee content/manuals/offload/v1/quickstart.md junto con content/manuals/offload/v1/core-concepts.md y compara sus descripciones de lo que se elimina cuando una sesión se detiene o queda inactiva. Actualiza la redacción de la guía de inicio rápido para que coincida con el comportamiento de eliminación completo descrito en core-concepts y, después, confirma que ambos archivos mencionen de forma coherente los contenedores, las imágenes y los volúmenes.

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

Descripción

Files:

  • content/manuals/offload/v1/quickstart.md
  • content/manuals/offload/v1/core-concepts.md
Issue

The two files provide inconsistent information about what gets deleted when a Docker Offload v1 session ends or goes idle.

In core-concepts.md:

If the idle period exceeds 5 minutes without activity, the session is terminated. Docker Offload v1 environments are ephemeral, so the remote environment and any containers, images, or volumes in it are deleted.

In quickstart.md:

When you stop Docker Offload v1, the cloud environment is terminated and all running containers and images are removed. When Docker Offload v1 has been idle for 5 minutes, the environment is also terminated and all running containers and images are removed.

Why this matters

  1. Missing volumes: The quickstart doesn't mention that volumes are deleted, which could lead to unexpected data loss for users who only read the quickstart.

  2. "Running" vs all containers: The quickstart says "running containers" while core-concepts says "containers" (implying all containers, not just running ones). This creates ambiguity about whether stopped containers are also deleted.

  3. Data loss risk: Users following the quickstart might not realize they need to back up volume data before their session ends, since volumes aren't mentioned in the deletion warning.

Suggested fix

Make the deletion behavior consistent across both files. The quickstart should match the more complete information in core-concepts:

In quickstart.md, change:

When you stop Docker Offload v1, the cloud environment is terminated and all running containers and images are removed. When Docker Offload v1 has been idle for 5 minutes, the environment is also terminated and all running containers and images are removed.

To:

When you stop Docker Offload v1, the cloud environment is terminated and all containers, images, and volumes are removed. When Docker Offload v1 has been idle for 5 minutes, the environment is also terminated and all containers, images, and volumes are removed.

Or add a note in the quickstart that references the core-concepts page for complete information about what gets deleted.

Found by nightly documentation quality scanner

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

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.