[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters
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
- 88/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
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md và so sánh bảng Container proxy của tệp này với settings-reference.md cùng các ví dụ về cài đặt lồng nhau ở gần đó. Cập nhật bảng để pac và embeddedPac được hiển thị rõ ràng bên dưới containersProxy, sau đó xác minh rằng tài liệu được kết xuất khớp với JSON ví dụ và không ngụ ý các khóa cấp cao nhất riêng biệt.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
File: content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md
Issue
The "Container proxy" section table presents pac and embeddedPac as if they are separate top-level parameters, when they are actually nested properties within the containersProxy object.
From the table:
Parameter OS Description Version containersProxyConfigures the proxy for docker image pull(always enforced) and running container outbound traffic (enforced whentransparentPortsis set). For more information see Air-Gapped Containers.pacSpecifies a PAC file URL. For example, "pac": "http://containerproxy/proxy.pac".embeddedPacSpecifies an embedded PAC (Proxy Auto-config) script. For example, "embeddedPac": "function FindProxyForURL(url, host) { return \"PROXY 192.168.92.1:2003\"; }". This setting takes precedence over HTTP, HTTPS, Proxy bypass and PAC server URL.
However, the example JSON in the same file shows the correct structure:
"containersProxy": {
"locked": true,
"mode": "manual",
"http": "",
"https": "",
"exclude": [],
"pac": "",
"embeddedPac": "",
"transparentPorts": ""
}
And settings-reference.md correctly documents this as a single JSON object with nested properties.
Why this matters
Administrators reading the table might incorrectly create their JSON configuration with pac and embeddedPac as separate top-level keys instead of nested within containersProxy. This would result in invalid configuration that Docker Desktop would ignore or reject.
Suggested fix
Restructure the table to show the nested relationship, similar to how other nested settings are documented in the same file (e.g., enhancedContainerIsolation.dockerSocketMount.imageList). Alternatively, present containersProxy as a single entry with a JSON example showing all its properties, matching the approach used in settings-reference.md.
Found by nightly documentation quality scanner
- Ngôn ngữ chính
- Markdown
- Star
- 4.7k
- Fork
- 8.5k
- Merge trung bình
- 1 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 127
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] Conflicting WSL version requirements between ECI pagesCó thể đã có người làm @dave123981 đã nhận 3 ngày trước. Đang mở
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 90/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 75/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[docs-scanner] Ambiguous version qualifier for MSI all-users installation requirementCó thể làm lại được Pull request cho issue này đã bị đóng mà không được merge. Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
Maintainer thường phản hồi trong vòng 1 ngày
-
[docs-scanner] Unclear relationship between sandbox:use PAT permission and granular account permissionsCó thể đã có người làm @dave123981 đã nhận 6 ngày trước. Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
docker/docs#26225 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[docs-scanner] Sandboxes API tutorial mentions client.get() without showing how to use itCó thể đã có người làm @nielskaspers đã nhận 6 ngày trước. Đang mở
Độ khó 1/5 1-3 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ự
-
area:docs
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
RailtownAI/railtracks#1633 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
review-panel severity:low
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
kristovatlas/coin-accounting#152 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation :blue_book:
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
PennyLaneAI/pennylane#10280 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
raycast/extensions#32000 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Resource]: Claude MonitorĐang mởresource-submission validation-passed
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
hesreallyhim/awesome-claude-code#3096 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày