[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日 5時間
- マージ済み PR（30日）
- 146
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
status/triage
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
[docs-scanner] Example uses deprecated Flocker volume driver対応中かも @aevesdocker が 3 日前に担当しました。 オープン
難易度 1/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 半日 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
status/triage
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
-
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
NetAppDocs/ontap#2157 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
facebookresearch/autoform-bot#448 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
vaccfr/vatis-profiles#62 ·