Skip to content

[docs-scanner] Confusing version requirement note in CVE scanning documentation #24399

@docker-agent

Description

@docker-agent

File: content/manuals/dhi/core-concepts/cves.md

Issue

The documentation includes a note about version requirements that appears twice in different contexts, creating potential confusion:

First instance (line ~150):

Note

The docker scout vex get command requires Docker Scout
CLI
version 1.18.3 or later.

If the image exists locally on your device, you must prefix the image name with registry://. For example, use
registry://dhi.io/python:3.13 instead of dhi.io/python:3.13.

This note combines two unrelated pieces of information:

  1. A version requirement (which could become stale)
  2. A syntax requirement for local images

The version requirement "1.18.3 or later" will become outdated as the minimum version changes, and mixing it with the syntax requirement makes both harder to understand.

Suggested fix

Split the note into two separate notes or remove the version requirement if it's no longer relevant:

> [!NOTE]
>
> If the image exists locally on your device, you must prefix the image name with `registry://`. For example, use
> `registry://dhi.io/python:3.13` instead of `dhi.io/python:3.13`.

If the version requirement is still needed, place it in a separate note focused only on version compatibility.


Found by nightly documentation freshness scanner

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions