Skip to content

[docs-scanner] Inconsistent terminology: 'nonroot' vs 'non-root' in DHI migration guides #25508

Description

@docker-agent

Files:

  • content/manuals/dhi/migration/checklist.md
  • content/manuals/dhi/migration/migrate-from-doi.md
  • content/manuals/dhi/migration/migrate-from-ubuntu.md

Issue

The DHI migration documentation uses inconsistent terminology for the non-root user. Some files use "nonroot" (no hyphen) while others use "non-root" (with hyphen).

Examples:

From checklist.md and migrate-from-doi.md:

Verify that all files and directories your application needs are readable and writable by the nonroot user (UID 65532)

Runtime variants run as the nonroot user by default

From migrate-from-ubuntu.md:

Runtime variants run as the non-root user by default. Ensure that necessary files and directories are accessible to the non-root user.

Run as a non-root user by default. Applications can't bind to privileged ports

Why this matters

Readers following multiple migration guides will encounter both "nonroot" and "non-root" and may wonder if these refer to different concepts or if one is a typo. This inconsistency undermines the documentation's authority and could cause confusion when searching for information or discussing the feature.

Suggested fix

Standardize on one term throughout all DHI migration documentation. Based on the majority usage and the fact that it's a UID reference, "nonroot" (without hyphen) appears to be the preferred form. Update migrate-from-ubuntu.md to use "nonroot" consistently.


Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    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