[docs-scanner] Swarm tutorial: Confusing version framing in rolling-update.md
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 88/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- docker
- Área
- documentation
Línea de trabajo
Lee content/manuals/engine/swarm/swarm-tutorial/rolling-update.md y localiza el párrafo sobre el despliegue de Redis. Elimina o revisa la nota sobre la etiqueta de Redis para que las instrucciones ya no dejen poco clara la elección de la versión. Se considerará terminado cuando el párrafo dé instrucciones claras para el despliegue sin insinuar que se debe usar una versión anterior sin explicación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Markdown
- Estrellas
- 4.7k
- Forks
- 8.5k
- Merge medio
- 1 d 22 h
- PR fusionados (30 d)
- 148
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de docker/docs
-
[docs-scanner] Inconsistent terminology: 'nested organization' vs 'organization in the company'Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
status/triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
docker/docs#26484 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
[docs-scanner] SSO overview omits OAT as CLI authentication optionPosiblemente ocupada @dave123981 la tomó hace 3 días. Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 92/100
Los mantenedores suelen responder en 1 día
Todos los issues de docker/docs
Issues similares
-
good first issue help wanted r-docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
servo/rust-smallvec#824 ·
Los mantenedores suelen responder en 1 día
-
[guide] AGENTS.md claims the coverage gate, e2e and full lint run on every PR after ADR 0011 focused validationPosiblemente ocupada @hivecommons-hive la tomó hoy. Abiertoagent/guide documentation hive/claimed-by-guide stage/040-covered-by-pr
Dificultad 2/5 1-3 horas Aptitud para principiantes 81/100
cncf/endusers#2006 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 2 días
-
Add dependency list in documentsAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
Los mantenedores suelen responder en 3 días
-
feedback simulation workshop
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
githubnext/gh-aw-workshop#5157 ·
Los mantenedores suelen responder en 1 día