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

[Enhancement]: Fix the explanation of the V2 Job specs to be more instructive

Đang mở
  • Có gì không ổn?
#778 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.

Đánh giá

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

Hướng nghiên cứu

Bắt đầu với phần shared-fields trong tài liệu V2 Job, đặc biệt là các giải thích về DAG, cú pháp DOT và observationSource. Xem xét liệu mỗi khái niệm có giúp người dùng nhanh chóng tạo và thêm một Job hay không; được coi là hoàn tất khi hướng dẫn có thể thực hiện được, liên kết đến các tài nguyên rõ ràng khi cần và tránh tạo thêm tải nhận thức không cần thiết.

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

Mô tả

Chainlink Nodes enhancement
What would you like us to improve?

In this section: https://docs.chain.link/docs/jobs/#shared-fields

  • Reference to DAGs (Directed Acyclical Graphs) are computer science implementation details that may not be relevant to the user? If we are including them it needs to further their ability to quickly implement Jobs and not just educate them on the inner workings of job specs. At the very least they should be linked to the most clear, easily digestible link we can find to explain what they are but then we need to also explain why it matters that pipelines need to be acyclical, why the way they're processed by the Node makes them a directed graph vs undirected graph, etc etc. May not be immediately necessary nor useful for the target audience?
  • I am not familiar with DOT syntax, and perhaps we need to link to an easily consumable resource on what that is. If we link users to something like this we will quickly lose them in a rabbit hole and they are not likely to achieve their goal of getting a job up and running.
  • the explanation under observationSource also encourages the reader to see below on info on writing pipeline DAGs. Cannot see any obvious resource? If users google what chainlink Jobs are and land on this page, they would need more actionable information for quick outcomes, that do not add to cognitive load with new concepts and terms.
How important it is?

Very important if the objective of this page is to get a user to have a Job specified and added to their Node asap. The focus should be on what is necessary and sufficient to get them to that outcome, and eliminate "nice to haves".

Ngôn ngữ chính
MDX
Star
527
Fork
480
Merge trung bình
1 ngày 50 phút
Pull request đã merge (30 ngày)
91

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 smartcontractkit/documentation

Tất cả issue của smartcontractkit/documentation

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.