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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#26,565 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é
1-3 heures
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Domaine
documentation

Piste de recherche

Lisez content/manuals/offload/v1/quickstart.md en parallèle de content/manuals/offload/v1/core-concepts.md et comparez leurs descriptions de ce qui est supprimé lorsqu’une session s’arrête ou expire après une période d’inactivité. Mettez à jour la formulation du guide de démarrage rapide pour qu’elle corresponde au comportement de suppression complet décrit dans core-concepts, puis confirmez que les deux fichiers mentionnent les conteneurs, les images et les volumes de manière cohérente.

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

Description

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

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

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.