[docs-scanner] Broken sentence in environment variables documentation
维护者通常 1 天内回复
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker, markdown
调研方向
阅读 content/manuals/compose/how-tos/environment-variables/variable-interpolation.md 第 117 行附近的内容,并查看链接的环境变量优先级页面以了解上下文。修正有问题的句子,使其清楚表达预期的关系,然后确认周围的文字读起来自然。
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Markdown
- 星标
- 4.7k
- 派生
- 8.5k
- 平均合并
- 2 天 8 小时
- 30 天内合并 PR
- 135
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
docker/docs 的其他 Issue
-
[docs-scanner] Example uses deprecated Flocker volume driver可能已有人在做 @aevesdocker 于 1 天前认领。 未关闭
难度 1/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
status/triage
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
难度 2/5 半天 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
status/triage
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
相似的 Issue
-
docs(storage-resize-images): kit README's Multiple instances section fails in an installed project未关闭kits type: bug
难度 2/5 1-3 小时 新手友好度 77/100
firebase/extensions#3271 ·
维护者通常 1 天内回复
-
https://docs.未关闭
难度 1/5 1 小时以内 新手友好度 72/100
-
Lists nested four or more levels deep have no left margin可能已有人在做 @tpavlic 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 83/100
josephwright/ltx-talk#292 ·
-
Say how an agent should weigh annotations that the page wrote about itself可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
webmachinelearning/webmcp#353 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 67/100
linebender/resvg#1179 · 1 条评论 ·
维护者通常 2 天内回复