Skip to content

[docs-scanner] Hard-coded RootlessKit version in external documentation links #24941

@docker-agent

Description

@docker-agent

File: content/manuals/engine/security/rootless/troubleshoot.md

Issue

The documentation links to RootlessKit documentation using a hard-coded version tag v2.0.0:

For more information about network drivers for RootlessKit, see RootlessKit documentation.

And later:

For more information about networking options for RootlessKit, see:

Why this matters

Hard-coding a specific version tag (v2.0.0) in external documentation links creates uncertainty for readers:

  1. If RootlessKit has released newer versions (v2.1, v2.5, v3.0, etc.), readers may think the Docker documentation is outdated
  2. Readers cannot tell if the linked information reflects current RootlessKit capabilities or historical ones
  3. Users may miss important updates, improvements, or changes in RootlessKit networking behavior that occurred after v2.0.0

This is particularly problematic in a troubleshooting context where users need current, accurate information to resolve issues.

Suggested fix

Link to a stable branch or latest version instead of a specific version tag:

  • Change v2.0.0 to master or main (whichever is the default branch)
  • Or link to the latest release tag dynamically
  • Or add context explaining why v2.0.0 is referenced (e.g., "compatible with Docker Engine 25.0" if that's the reason)

Example:

For more information about network drivers for RootlessKit, see [RootlessKit documentation](https://github.com/rootless-containers/rootlesskit/blob/master/docs/network.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