[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Anfängerfreundlichkeit
- 88/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- docker
- Bereich
- documentation
Rechercherichtung
Beginne mit content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md und vergleiche dessen Tabelle zu Container proxy mit settings-reference.md und den Beispielen für verschachtelte Einstellungen in der Nähe. Aktualisiere die Tabelle so, dass pac und embeddedPac eindeutig unter containersProxy angezeigt werden, und überprüfe anschließend, dass die gerenderte Dokumentation mit dem Beispiel-JSON übereinstimmt und keine separaten Top-Level-Schlüssel impliziert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Markdown
- Sterne
- 4.7k
- Forks
- 8.5k
- Ø Merge
- 2 T. 1 Std.
- Gemergte PRs (30 T.)
- 139
Entwicklungsumgebung
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus docker/docs
-
[docs-scanner] SSO multi-IdP configuration placed after enforcement sectionEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
Maintainer antworten meist innerhalb von 1 Tag
-
status/triage
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
-
status/triage
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
-
[docs-scanner] Example uses deprecated Flocker volume driverEvtl. vergeben @aevesdocker hat das vor 6 Tagen übernommen. Offen
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 82/100
docker/docs#26376 · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
aws-samples/sample-per-model-bedrock#526 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
elder-plinius/V3R1T4S#757 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
EleutherAI/lm-evaluation-harness#4460 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
openpubkey/opkssh#670 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
registrystack/registry-stack#2431 ·
Maintainer antworten meist innerhalb von 1 Tag