Skip to content

[docs-scanner] Missing explanation of Admin Console states to JSON mapping #24969

@docker-agent

Description

@docker-agent

Files:

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

Issue

The documentation describes two different configuration methods but doesn't explain how they relate to each other:

In configure-admin-console.md:

Configure each setting using a state:

  • User-defined: Users can change the setting.
  • Always enabled: Setting is on and locked.
  • Enabled: Setting is on but can be changed.
  • Always disabled: Setting is off and locked.
  • Disabled: Setting is off but can be changed.

In configure-json-file.md:

Each setting supports a locked field that controls user permissions:

  • When locked is set to true, users can't change that value
  • When locked is set to false, the value acts like a default suggestion

Why this matters

Administrators who use both configuration methods (or migrate between them) need to understand how Admin Console states map to JSON locked and value combinations. For example:

  • Does "Always enabled" translate to "locked": true, "value": true?
  • Does "User-defined" mean omitting the setting entirely, or setting "locked": false?
  • What's the JSON equivalent of "Enabled" (unlocked but set to true)?

Without this mapping, administrators can't:

  • Verify that Admin Console policies match their JSON configurations
  • Migrate from JSON to Admin Console (or vice versa) with confidence
  • Troubleshoot why settings behave differently between the two methods

Suggested fix

Add a mapping table or explanation in one or both files showing the relationship:

Admin Console State JSON Equivalent
Always enabled "locked": true, "value": true
Always disabled "locked": true, "value": false
Enabled "locked": false, "value": true
Disabled "locked": false, "value": false
User-defined Setting not included in JSON

Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

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