Skip to content

[docs-scanner] Inconsistent policy stable ID for copyleft licenses policy #25934

Description

@docker-agent

File:content/manuals/scout/policy/local.md

Issue

The copyleft licenses policy has inconsistent stable IDs in different parts of the documentation.

In the example configuration (line 182):

{
"policies": [
{
"name": "no-copyleft-licenses",
"weight": 0
}
]
}

But in the Configuration reference table (lines 247-248):

| copyleft-license | licenses | AGPL/GPL/LGPL/MPL/… | SPDX license IDs treated as copyleft |
| copyleft-license | ignored_packages | [] | Package URLs exempted from the check |

Why this matters

A reader trying to configure the copyleft licenses policy would see the example using "no-copyleft-licenses" but then find the configuration options listed under copyleft-license in the reference table. This creates confusion about which stable ID to actually use in their policy-config file. If they use the wrong ID, their configuration won't work as expected.

Suggested fix

Verify the correct stable ID for this policy and make it consistent throughout the document. Either:

  • Change the example to use "copyleft-license" (if that's the correct ID), or
  • Change the configuration reference table to use no-copyleft-licenses (if that's the correct ID)

The same stable ID should be used in both the example and the configuration reference table.


Found by nightly documentation quality scanner

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