Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta Para iniciantes
  • Algo errado?
#26,433 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@dave123981 já está trabalhando nisso.

Desde 27/10/2026.

  • #26455 de @dave123981 — aberto

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
88/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
docker
Domínio
documentation

Direção de pesquisa

Leia content/manuals/engine/swarm/swarm-tutorial/rolling-update.md e localize o parágrafo sobre a implantação do Redis. Remova ou revise a observação sobre a tag do Redis para que as instruções não deixem mais dúvidas sobre a escolha da versão. O trabalho estará concluído quando o parágrafo fornecer instruções claras de implantação sem sugerir uma versão mais antiga sem explicação.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Markdown
Estrelas
4.7k
Forks
8.5k
Merge médio
1d 22h
PRs com merge (30d)
148

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de docker/docs

Todas as issues de docker/docs

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.