Skip to content

[docs-scanner] Inconsistent Docker Scout CLI command naming in CI integration guides #24843

@docker-agent

Description

@docker-agent

Files:

  • content/manuals/scout/integrations/ci/azure.md
  • content/manuals/scout/integrations/ci/circle-ci.md
  • content/manuals/scout/integrations/ci/gitlab.md
  • content/manuals/scout/integrations/ci/jenkins.md

Issue

The CI integration guides use inconsistent command names for Docker Scout CLI, mixing docker scout (with space) and docker-scout (with hyphen):

azure.md uses:

docker scout cves $(image):$(tag) --exit-code --only-severity critical,high

circle-ci.md uses:

docker-scout cves $IMAGE_TAG --exit-code --only-severity critical,high

gitlab.md uses:

docker scout cves "$CI_REGISTRY_IMAGE${tag}" --exit-code --only-severity critical,high

jenkins.md uses:

docker-scout cves $IMAGE_TAG --exit-code --only-severity critical,high

Why this matters

Users following these guides will copy-paste commands and may encounter errors if they use the wrong format. The inconsistency creates confusion about which command name is correct, undermining trust in the documentation. Users switching between different CI platforms will see different command formats and won't know which to use.

Suggested fix

Standardize on one command format across all CI integration guides. Based on the Docker Scout CLI documentation, the correct format should be determined and applied consistently to all four files (azure.md, circle-ci.md, gitlab.md, jenkins.md).


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