Skip to content

[docs-scanner] Misleading prerequisites for VEX exceptions #24900

@docker-agent

Description

@docker-agent

File: content/manuals/scout/how-tos/create-exceptions-vex.md

Issue

The prerequisites section lists containerd image store as a requirement for creating exceptions using VEX documents:

To create exceptions using OpenVEX documents, you need:

  • The latest version of Docker Desktop or the Docker Scout CLI plugin
  • The vexctl command line tool.
  • The containerd image store must be enabled
  • Write permissions to the registry repository where the image is stored

However, the document describes two methods for attaching VEX documents:

  1. Attestation - requires containerd image store
  2. Image filesystem - does NOT require containerd image store

The prerequisites incorrectly suggest that containerd is required for all VEX exception workflows.

Why this matters

A reader who wants to use the "Image filesystem" method (embedding VEX documents in the image) will be confused about why containerd is listed as a prerequisite. They may unnecessarily enable containerd or believe they cannot use VEX exceptions without it.

Additionally, the "Write permissions to the registry repository" prerequisite only applies to the attestation method, not the filesystem method.

Suggested fix

Move the method-specific prerequisites into the respective sections:

  • Move "The containerd image store must be enabled" and "Write permissions to the registry repository" to the "Attestation" section
  • Keep only the universal prerequisites (Docker Desktop/CLI plugin and vexctl) in the main prerequisites section

Alternatively, clarify in the prerequisites section which requirements apply to which method:

## Prerequisites

To create exceptions using OpenVEX documents, you need:

- The latest version of Docker Desktop or the Docker Scout CLI plugin
- The [`vexctl`](https://github.com/openvex/vexctl) command line tool

Additional prerequisites depend on the attachment method:

- **For attestations**: The [containerd image store](/manuals/desktop/features/containerd.md) must be enabled, and you need write permissions to the registry repository where the image is stored
- **For image filesystem**: No additional prerequisites

Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions