[docs-scanner] Broken sentence in environment variables documentation
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 78/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- docker, markdown
- Ambito
- documentation
Direzione di ricerca
Leggi content/manuals/compose/how-tos/environment-variables/variable-interpolation.md intorno alla riga 117 e consulta la pagina collegata sulla precedenza delle variabili d’ambiente per avere il contesto. Correggi la frase errata in modo che esprima chiaramente la relazione prevista, quindi verifica che il testo circostante risulti naturale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Markdown
- Stelle
- 4.7k
- Fork
- 8.5k
- Merge medio
- 2g 8h
- PR unite (30g)
- 135
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di docker/docs
-
[docs-scanner] Example uses deprecated Flocker volume driverForse già presa @aevesdocker l’ha presa 1 giorno fa. Aperta
Difficoltà 1/5 1-3 ore Idoneità per principianti 82/100
docker/docs#26376 · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
status/triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 Mezza giornata Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
status/triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
Old versions of datamodelsApertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
NatLabRockies/OpenStudio-HPXML#2284 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
ROCm/rocm-libraries#14018 ·
I maintainer di solito rispondono entro 2 giorni
-
area/kotlin
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
Qiskit/documentation#5839 ·
I maintainer di solito rispondono entro 1 giorno