Skip to content

[docs-scanner] Confusing authentication requirement in DHI build documentation #24818

@docker-agent

Description

@docker-agent

File: content/manuals/dhi/how-to/build.md

Issue

The authentication requirement in the Important callout is misleading:

You must authenticate to the Docker Hardened Images registry (dhi.io) to pull base images and build tools. Use your Docker ID credentials (the same username and password you use for Docker Hub) when signing in.

Run docker login dhi.io to authenticate.

This appears in a section about building DHI definition files (YAML-based builds), but the phrasing "to pull base images and build tools" makes it sound like this authentication is required whenever using DHIs as base images in any Dockerfile.

Cross-referencing with use.md and verify.md in the same directory shows that authentication to dhi.io is required for pulling DHI Community images generally, not specifically for building. The context here should clarify that this authentication is needed because the DHI build frontend itself pulls from dhi.io, not because using a DHI as a base image requires special authentication.

Why this matters

A reader following the "Try it: build a catalog image" section might think they need to authenticate to dhi.io whenever they use a DHI as a base image in a regular Dockerfile (like FROM dhi.io/python:3.13). The current wording doesn't distinguish between:

  • Building DHI definition files (YAML-based, requires dhi.io access for the build frontend)
  • Using DHIs as base images in regular Dockerfiles (requires dhi.io access for pulling, same as any DHI usage)

Suggested fix

Rewrite the Important callout to clarify the context:

Important

The DHI build system pulls base images and build tools from dhi.io. You must authenticate using your Docker ID credentials (the same username and password you use for Docker Hub).

Run docker login dhi.io to authenticate.

Or integrate this into the surrounding prose rather than using a callout, since authentication is a standard prerequisite for working with DHIs.


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