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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#26,565 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc content/manuals/offload/v1/quickstart.md cùng với content/manuals/offload/v1/core-concepts.md và so sánh mô tả về những gì bị xóa khi một phiên kết thúc hoặc chuyển sang trạng thái không hoạt động. Cập nhật cách diễn đạt trong hướng dẫn bắt đầu nhanh để khớp với hành vi xóa hoàn toàn được mô tả trong core-concepts, sau đó xác nhận cả hai tệp đều đề cập nhất quán đến container, image và volume.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Markdown
Star
4.7k
Fork
8.5k
Merge trung bình
2 ngày 8 giờ
Pull request đã merge (30 ngày)
133

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của docker/docs

Tất cả issue của docker/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.