[docs-scanner] Broken sentence in environment variables documentation
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức phù hợp với người mới
- 78/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- docker, markdown
- Lĩnh vực
- documentation
Hướng nghiên cứu
Đọc content/manuals/compose/how-tos/environment-variables/variable-interpolation.md quanh dòng 117 và xem trang được liên kết về thứ tự ưu tiên của biến môi trường để nắm ngữ cảnh. Sửa câu bị lỗi để câu diễn đạt rõ mối quan hệ dự kiến, sau đó xác nhận văn bản xung quanh đọc tự nhiên.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- Markdown
- Star
- 4.7k
- Fork
- 8.5k
- Merge trung bình
- 2 ngày 8 giờ
- Pull request đã merge (30 ngày)
- 135
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của docker/docs
-
[docs-scanner] Example uses deprecated Flocker volume driverCó thể đã có người làm @aevesdocker đã nhận 1 ngày trước. Đang mở
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 82/100
docker/docs#26376 · 1 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
-
status/triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
status/triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
apache/rocketmq-dashboard#7248 ·
Maintainer thường phản hồi trong vòng 3 ngày
-
[BUG] Still libmicrohttpd dependency is not removed properly from External-Dependency-Info.txt fileĐang mởtype/bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
mattpocock/skills#1307 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
sync-en
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
sync-en
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 77/100
Maintainer thường phản hồi trong vòng 3 ngày