[docs-scanner] DCT retirement notice missing from trust documentation pages

Đang mở
  • Có gì không ổn?
#26,286 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

  • #26287 của @nielskaspers — đã đóng, không merge

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Read the existing retirement warning in content/manuals/engine/security/trust/_index.md and compare it with the five listed trust pages. Add the specified notice, shutdown date, and retirement-documentation link to each page, then verify all five render with the warning at the top. A linked open pull request is already present, so check its status before starting.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

area/engine area/security status/confirmed

Files:

  • content/manuals/engine/security/trust/deploying_notary.md
  • content/manuals/engine/security/trust/trust_automation.md
  • content/manuals/engine/security/trust/trust_delegation.md
  • content/manuals/engine/security/trust/trust_key_mng.md
  • content/manuals/engine/security/trust/trust_sandbox.md
Issue

The main index page (_index.md) contains a prominent warning that Docker Content Trust is being retired:

Docker Content Trust (DCT) is being retired. The Notary v1 service at
notary.docker.io will shut down on December 8, 2026.

However, all five other pages in this directory provide detailed how-to instructions for using DCT with no mention of this retirement or deprecation. These pages read as if DCT is a current, fully-supported feature:

  • deploying_notary.md - "The easiest way to deploy Notary Server is by using Docker Compose"
  • trust_automation.md - "It is very common for Docker Content Trust to be built into existing automation systems"
  • trust_delegation.md - "Delegations in Docker Content Trust (DCT) allow you to control who can and cannot sign an image tag"
  • trust_key_mng.md - "Trust for an image tag is managed through the use of keys"
  • trust_sandbox.md - "This page explains how to set up and use a sandbox for experimenting with trust"
Why this matters

A reader who navigates directly to any of these five pages (via search, link, or navigation) will follow detailed instructions to set up and use DCT without knowing it's being retired. They may invest significant time configuring DCT only to discover later that:

  1. The service is shutting down in December 2026
  2. They need to migrate to an alternative solution
  3. The feature they just learned is deprecated

This is particularly problematic for the automation and delegation pages, which describe integration patterns that would require significant investment.

Suggested fix

Add a deprecation notice at the top of each of these five pages, similar to the warning in _index.md. The notice should:

  1. State that DCT is being retired
  2. Mention the December 8, 2026 shutdown date
  3. Link to the retirement documentation at /manuals/retired.md#docker-content-trust-dct

Example:

> [!WARNING]
>
> Docker Content Trust (DCT) is being retired. The Notary v1 service at
> `notary.docker.io` will shut down on December 8, 2026. For more information, see
> [Docker Content Trust (DCT)](/manuals/retired.md#docker-content-trust-dct).

Found by nightly documentation quality scanner

Ngôn ngữ chính
Markdown
Star
4.7k
Fork
8.5k
Merge trung bình
2 ngày 11 giờ
Pull request đã merge (30 ngày)
135

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của docker/docs

Tất cả issue của docker/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.