Skip to content

[docs-scanner] Outdated version framing in base-images.md example #25290

@github-actions

Description

@github-actions

File: content/manuals/build/building/base-images.md

Issue

The example code uses Ubuntu 24.04 (Noble) without any context about when this version was released, which could make readers uncertain whether the example reflects current best practices:

$ sudo debootstrap noble noble > /dev/null
$ sudo tar -C noble -c . | docker import - noble

sha256:81ec9a55a92a5618161f68ae691d092bf14d700129093158297b3d01593f4ee3

$ docker run noble cat /etc/lsb-release

DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=24.04
DISTRIB_CODENAME=noble
DISTRIB_DESCRIPTION="Ubuntu 24.04.2 LTS"

Why this matters

Ubuntu 24.04 was released in April 2024. While it's still a current LTS release, using it in documentation without context could confuse readers in the future about whether this is an up-to-date example or legacy content. The example would benefit from either:

  • Using a more generic version reference
  • Adding a brief note that this is an example and versions should be adjusted
  • Using a variable approach that makes it clear the version is just an example

Suggested fix

Consider one of these approaches:

  1. Add a brief note before the example:
    "The following example creates an Ubuntu 24.04 base image. Adjust the version codename (noble) to match your desired Ubuntu release."

  2. Or make the example more generic by using a variable pattern in the explanation


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