Skip to content

[docs-scanner] Inconsistent file path formatting for admin-settings.json location #24968

@docker-agent

Description

@docker-agent

Files:

  • content/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md
  • content/manuals/enterprise/security/hardened-desktop/settings-management/_index.md

Issue

The documentation shows inconsistent formatting for macOS file paths containing spaces:

In configure-json-file.md:

  • Mac: /Library/Application\ Support/com.docker.docker/admin-settings.json

In _index.md:

  • Mac: ~/Library/Application Support/Docker/settings-store.json

The first path uses backslash-escaped spaces (\ ), which is shell syntax for command-line usage. The second path shows the space without escaping, which is the actual filesystem path.

Why this matters

Readers trying to manually create or locate the admin-settings.json file will be confused about the correct path:

  • If they copy the path literally with the backslash, it won't work in most contexts (file browsers, text editors, etc.)
  • The inconsistency between the two files suggests uncertainty about the correct format
  • Users unfamiliar with shell escaping might think the backslash is part of the actual directory name

Suggested fix

Use consistent path formatting across all Settings Management documentation:

  • For file paths (not shell commands): ~/Library/Application Support/Docker/...
  • For shell commands: Wrap paths in quotes: "/Library/Application Support/com.docker.docker/admin-settings.json"

The current context in configure-json-file.md says "place it in the following locations:", which indicates file paths, not shell commands, so the backslash escaping should be removed.


Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent/generatedarea/adminRelates to Docker Adminstatus/confirmedIssue triaged and confirmed as a real problem, ready to fix

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions