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

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#26,565 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
88/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

Lies content/manuals/offload/v1/quickstart.md zusammen mit content/manuals/offload/v1/core-concepts.md und vergleiche ihre Beschreibungen dazu, was entfernt wird, wenn eine Sitzung beendet wird oder in den Leerlauf wechselt. Passe die Formulierung im Quickstart an das vollständige Löschverhalten an, das in core-concepts beschrieben wird, und bestätige anschließend, dass beide Dateien Container, Images und Volumes einheitlich erwähnen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Markdown
Sterne
4.7k
Forks
8.5k
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
133

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docker/docs

Alle Issues in docker/docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.