Skip to content

[docs-scanner] Outdated urgency framing for GitHub Cache API v2 migration #26466

Open

Description

@docker-agent

File: content/manuals/build/ci/github-actions/cache.md

Issue

The "Important" callout about GitHub Cache API v2 migration uses urgent language that suggests this is a current/imminent issue, but the deadline mentioned is "April 15th, 2025":

As of April 15th, 2025, only GitHub Cache service API v2 is supported.. The legacy v1 API has been shut down.

The framing "As of April 15th, 2025" combined with "has been shut down" creates confusion about whether this is:

  • A future event (the date is in the future from when this was written)
  • A past event (the "has been shut down" language)
  • Current guidance (the "Important" callout suggests urgency)

Why this matters

Readers encountering this in late 2025 or 2026 will be confused about whether this is still relevant or if they need to take action. The temporal framing makes it unclear whether the migration deadline has passed or is approaching. If the deadline has already passed, the urgent tone and troubleshooting guidance for "outdated tools" may no longer be necessary for most users.

Suggested fix

If the April 15, 2025 deadline has passed:

  • Remove or simplify the "Important" callout
  • Reframe as historical context: "GitHub Cache service API v2 is required. The legacy v1 API was shut down on April 15, 2025."
  • Consider whether the extensive troubleshooting section is still needed, or if it should be condensed

If the deadline is still future:

  • Use clearer temporal language: "Starting April 15, 2025, only GitHub Cache service API v2 will be supported."
  • Change "has been shut down" to "will be shut down"

Found by nightly documentation quality scanner

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions