[docs-scanner] Swarm tutorial: Confusing version framing in rolling-update.md

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#26,433 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

@dave123981 đang làm issue này rồi.

Từ ngày 27/10/2026.

  • #26455 của @dave123981 — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một 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
Công nghệ
docker
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc content/manuals/engine/swarm/swarm-tutorial/rolling-update.md và tìm đoạn văn về việc triển khai Redis. Xóa hoặc sửa ghi chú về tag Redis để hướng dẫn không còn khiến việc chọn phiên bản trở nên không rõ ràng. Hoàn thành khi đoạn văn đưa ra hướng dẫn triển khai rõ ràng mà không ngụ ý sử dụng phiên bản cũ hơn nhưng không giải thích lý do.

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

Mô tả

File: content/manuals/engine/swarm/swarm-tutorial/rolling-update.md

Issue

The tutorial includes a confusing note about Redis versions:

Deploy your Redis tag to the swarm and configure the swarm with a 10 second update delay. Note that the following example shows an older Redis tag:

$ docker service create \
  --replicas 3 \
  --name redis \
  --update-delay 10s \
  redis:7.4.0

The phrase "Note that the following example shows an older Redis tag" is unclear and potentially confusing:

  • It doesn't explain what the version is "older" than
  • Redis 7.4.0 was released in 2024, so calling it "older" without context is ambiguous
  • The note doesn't provide actionable information for the reader
Why this matters

Readers may wonder:

  • Should they use a different, newer version instead?
  • Is the tutorial outdated?
  • What version should they actually use?

The note creates uncertainty without adding value. The tutorial's purpose is to demonstrate rolling updates, not to recommend specific Redis versions.

Suggested fix

Remove the confusing note. The tutorial works with any two sequential Redis versions. If a note is needed, it should clarify the purpose:

Deploy Redis to the swarm and configure the swarm with a 10 second update delay:

Or, if you want to acknowledge version choice:

Deploy Redis to the swarm and configure the swarm with a 10 second update delay. This example uses Redis 7.4.0, but you can use any Redis version:

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 13 giờ
Pull request đã merge (30 ngày)
141

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.