Skip to content

[docs-scanner] Compression level ranges contradict between overview and exporter pages #24633

@docker-agent

Description

@docker-agent

Files:

  • content/manuals/build/exporters/_index.md
  • content/manuals/build/exporters/image-registry.md
  • content/manuals/build/exporters/oci-docker.md

Issue

The overview page states that different compression algorithms support different compression level ranges:

Use the compression-level=<value> option alongside the compression parameter to choose a compression level for the algorithms which support it:

  • 0-9 for gzip and estargz
  • 0-22 for zstd

However, the parameter tables in both image-registry.md and oci-docker.md list the compression-level range as simply 0..22 without specifying which algorithms support which ranges:

| compression-level | 0..22 | | Compression level, see [compression][1]

Why this matters

A reader following the parameter tables might try to use compression-level=15 with gzip compression, expecting it to work based on the 0..22 range shown in the table. According to the overview, this should fail or be invalid since gzip only supports 0-9. This contradiction creates confusion about valid parameter values.

Suggested fix

Update the parameter tables in image-registry.md and oci-docker.md to clarify the range:

| compression-level | 0..9 for gzip/estargz, 0..22 for zstd | | Compression level, see [compression][1]

Or alternatively, keep the table simple but ensure the linked compression section in the overview is prominently referenced and clear about the different ranges.


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