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

Aperta Adatta ai principianti
  • Qualcosa non va?
#26,565 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Leggi content/manuals/offload/v1/quickstart.md insieme a content/manuals/offload/v1/core-concepts.md e confronta le descrizioni di ciò che viene rimosso quando una sessione si arresta o diventa inattiva. Aggiorna la formulazione della guida introduttiva in modo che corrisponda al comportamento di eliminazione completo descritto in core-concepts, quindi conferma che entrambi i file menzionino in modo coerente i container, le immagini e i volumi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
2g 8h
PR unite (30g)
133

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docker/docs

Tutte le issue di docker/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.