[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters

Aberta Para iniciantes
  • Algo errado?
#26,263 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@dave123981 já está trabalhando nisso.

Desde 4/10/2026.

  • #26268 de @dave123981 — aberto

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
88/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
docker
Domínio
documentation

Direção de pesquisa

Comece com content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md e compare a tabela Container proxy com settings-reference.md e com os exemplos de configurações aninhadas próximos. Atualize a tabela para que pac e embeddedPac sejam exibidos claramente em containersProxy e, em seguida, verifique se a documentação renderizada corresponde ao JSON de exemplo e não implica chaves separadas de nível superior.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

area/desktop area/enterprise status/confirmed

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
containersProxy Configures the proxy for docker image pull (always enforced) and running container outbound traffic (enforced when transparentPorts is set). For more information see Air-Gapped Containers.
pac Specifies a PAC file URL. For example, "pac": "http://containerproxy/proxy.pac".
embeddedPac Specifies 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

Linguagem predominante
Markdown
Estrelas
4.7k
Forks
8.5k
Merge médio
2d 9h
PRs com merge (30d)
126

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de docker/docs

Todas as issues de docker/docs

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.