[docs-scanner] Broken sentence in environment variables documentation
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- docker, markdown
- Área
- documentation
Línea de trabajo
Lee content/manuals/compose/how-tos/environment-variables/variable-interpolation.md alrededor de la línea 117 y consulta la página enlazada sobre la precedencia de las variables de entorno para tener contexto. Corrige la frase defectuosa para que exprese claramente la relación prevista y, después, confirma que el texto circundante se lee con naturalidad.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
File: content/manuals/compose/how-tos/environment-variables/variable-interpolation.md
Issue
Line 117 contains a broken sentence with missing words and a double space:
Be aware of Environment variables precedence when using variables in an
.envfile that as environment variables in your container's environment.
The text "that as" (with two spaces) is grammatically incorrect and missing words between "that" and "as".
Why this matters
Readers cannot understand what this sentence is trying to communicate. The missing words make it impossible to determine what relationship is being described between .env file variables and container environment variables.
Suggested fix
The sentence should likely read one of:
- "when using variables in an
.envfile that are also used as environment variables in your container's environment" - "when using variables in an
.envfile that serve as environment variables in your container's environment"
The correct phrasing depends on the intended meaning, but either would restore comprehensibility.
Found by nightly documentation quality scanner
- Lenguaje dominante
- Markdown
- Estrellas
- 4.7k
- Forks
- 8.5k
- Merge medio
- 2 d 8 h
- PR fusionados (30 d)
- 135
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] Example uses deprecated Flocker volume driverPosiblemente ocupada @aevesdocker la tomó hace 1 día. Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 82/100
docker/docs#26376 · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
status/triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 Medio día Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
status/triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
Todos los issues de docker/docs
Issues similares
-
bug documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
awslabs/visual-asset-management-system#514 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
rancher/fleet-product-docs#417 ·
Los mantenedores suelen responder en 1 día
-
good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
dafonton77-tech/Cadreenf#10 ·
-
docs(storage-resize-images): kit README's Multiple instances section fails in an installed projectAbiertokits type: bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
firebase/extensions#3271 ·
Los mantenedores suelen responder en 1 día
-
https://docs.Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100