Skip to content

[docs-scanner] Confusing reference to Docker CLI in backend tutorial #25194

@github-actions

Description

@github-actions

File: content/manuals/extensions/extensions-sdk/build/backend-extension-tutorial.md

Issue

In the "Why add a backend?" section, the text creates confusion about how extensions access Docker functionality:

"Thanks to the Docker Extensions SDK, most of the time you should be able to do what you need from the Docker CLI directly from the frontend."

The phrase "from the Docker CLI" is misleading because:

  1. The linked section shows using the Extension API client (ddClient.docker.cli.exec), not the Docker CLI directly
  2. The phrasing suggests direct CLI access, when it's actually mediated through the Extension API
  3. This is in a section explaining when you DON'T need a backend, so clarity about what the frontend can do is important

Why this matters

Readers might misunderstand the relationship between the Extension API and Docker CLI access. They might think they can run Docker CLI commands directly from the frontend, or conversely, not realize that ddClient.docker.cli.exec gives them CLI-equivalent functionality. This confusion could lead to unnecessary backend implementations or missed frontend capabilities.

Suggested fix

Clarify that the Extension API provides access to Docker functionality, not direct CLI access:

"Thanks to the Docker Extensions SDK, most of the time you should be able to do what you need using the Extension API client from the frontend, which provides access to Docker CLI commands through ddClient.docker.cli.exec."

Or more concisely:

"Thanks to the Docker Extensions SDK, most of the time you should be able to do what you need from the frontend using the Extension API."


Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions