Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭 适合新手
#26,433 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@dave123981 已经在做这个了。

开始于 2026年10月27日。

  • #26455 来自 @dave123981 —— 未关闭

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
88/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
docker
领域
documentation

调研方向

阅读 content/manuals/engine/swarm/swarm-tutorial/rolling-update.md,并找到有关 Redis 部署的段落。删除或修改有关 Redis 标签的注释,避免指引对版本选择含糊不清。完成标准是该段落给出明确的部署指引,且不再暗示使用一个没有解释原因的旧版本。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
Markdown
星标
4.7k
派生
8.5k
平均合并
1 天 22 小时
30 天内合并 PR
148

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

docker/docs 的其他 Issue

查看 docker/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。