[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Accessibilité débutants
- 88/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- docker
- Domaine
- documentation
Piste de recherche
Commencez par content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md et comparez son tableau Container proxy avec settings-reference.md et les exemples de paramètres imbriqués situés à proximité. Mettez à jour le tableau afin que pac et embeddedPac soient clairement affichés sous containersProxy, puis vérifiez que la documentation rendue correspond à l’exemple JSON et n’implique pas l’existence de clés de niveau supérieur distinctes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
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
- Langage dominant
- Markdown
- Étoiles
- 4.7k
- Forks
- 8.5k
- Merge moyen
- 2 j 1 h
- PR mergées (30 j)
- 139
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de docker/docs
-
[docs-scanner] SSO multi-IdP configuration placed after enforcement sectionPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
-
status/triage
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
status/triage
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
[docs-scanner] Example uses deprecated Flocker volume driverPeut-être pris @aevesdocker l’a pris il y a 6 jours. Ouverte
Difficulté 1/5 1-3 heures Accessibilité débutants 82/100
docker/docs#26376 · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 Une demi-journée Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de docker/docs
Issues similaires
-
bug priority: P3 ready-for-agent
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
shep-pm/shep-kelpie#1332 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
Link Checker ReportOuverteautomated issue report
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 70/100
microsoft/playwright#43640 ·
Les mainteneurs répondent en général sous 1 jour
-
units: No `#` in rustdoc headingPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 67/100
rust-bitcoin/rust-bitcoin#7089 · 1 commentaire · 1 réaction ·
Les mainteneurs répondent en général sous 2 jours