Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document: a component reference to a draft stores its published component

Đang mở Phù hợp với người mới
#262 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

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

Hướng nghiên cứu

Issue mô tả hành vi của API đối với vị trí component, dữ liệu trang và {component}/usage, nhưng không nêu tên tệp tài liệu hay bài kiểm thử nào. Hãy bắt đầu bằng cách tìm tài liệu API về vị trí component và dữ liệu trang, sau đó kiểm tra cách mô tả các tham chiếu component liên quan và số lượt sử dụng. Công việc được xem là hoàn tất khi tài liệu giải thích cách phân giải bản nháp, danh tính khi xuất bản lần đầu, cũng như phản hồi về mức sử dụng và quy tắc đếm.

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

Mô tả

From api-components-bundle #520 / PR https://github.com/components-web-app/api-components-bundle/pull/523.

For the API section (component positions and page data):

  • A component position, or a page-data component property, never holds a draft of a published component. When a write names such a draft's IRI (POST/PATCH /_/component_positions, positions embedded in a component write, a page-data PATCH, fixtures), the published component is stored instead, because the two resolve to the same thing. Admins still see the draft through the position, as before.
  • A never-published draft is stored as is. Its first publish keeps the same row and IRI, so every reference to it stays.
  • GET {component}/usage returns {positionCount, pageDataCount, total}. The total counts a published component and its draft once.
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 20 phút
Pull request đã merge (30 ngày)
1

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 components-web-app/docs

Tất cả issue của components-web-app/docs

Issue tương tự

Thêm issue về TypeScript

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.