[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- docker
- Domain
- documentation
Research direction
Start with content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md and compare its Container proxy table with settings-reference.md and the nearby nested-setting examples. Update the table so pac and embeddedPac are clearly shown under containersProxy, then verify the rendered documentation matches the example JSON and does not imply separate top-level keys.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 128
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from docker/docs
-
status/triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
[docs-scanner] Conflicting WSL version requirements between ECI pagesPossibly taken @dave123981 claimed this 4 days ago. Open
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
[docs-scanner] Ambiguous version qualifier for MSI all-users installation requirementMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
[docs-scanner] Unclear relationship between sandbox:use PAT permission and granular account permissionsPossibly taken @dave123981 claimed this 7 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
docker/docs#26225 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
Code Cleanup Dev Environment
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ProjectSidewalk/SidewalkWebpage#5699 ·
Maintainers usually reply within 1 day
-
area/install documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
community documentation first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 70/100
lingdojo/kana-dojo#31864 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
climate-analytics-lab/jax-gcm#1057 ·
Maintainers usually reply within 1 day