Sitelet https://github.com/docker/docs/issues/26264
Skip to content

[docs-scanner] dockerDaemonOptions description incorrectly states value is boolean #26264

Description

@docker-agent

File: content/manuals/desktop/enterprise/hardened-desktop/settings-management/configure-json-file.md

Issue

The description for dockerDaemonOptions incorrectly states the value is a boolean when it's actually a JSON string.

From the Linux VM settings table:

|        dockerDaemonOptions | | If value is set to true, it overrides the options in the Docker Engine config file. See the Docker Engine reference. Note that for added security, a few of the config attributes may be overridden when Enhanced Container Isolation is enabled. | |

However, the example JSON in the same file shows:

"dockerDaemonOptions": {
  "locked": false,
  "value": "{\"debug\": false}"
}

The value field contains a stringified JSON object ("{\"debug\": false}"), not a boolean.

Why this matters

The phrase "If value is set to true" misleads administrators about the data type. They might try to set "value": true instead of providing a JSON string like "value": "{\"debug\": false}". This would result in configuration errors.

Suggested fix

Change the description to accurately reflect that value contains a JSON string. For example:

"The value field contains a JSON string that overrides options in the Docker Engine config file. See the Docker Engine reference. Note that for added security, a few of the config attributes may be overridden when Enhanced Container Isolation is enabled."

Note: settings-reference.md has the correct description: "Overrides the Docker daemon configuration used in containers, without modifying local configuration files."


Found by nightly documentation quality scanner

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions