[Enhancement]: Fix the explanation of the V2 Job specs to be more instructive
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
V2 Job ドキュメントの shared-fields セクションから始め、特に DAG、DOT 構文、observationSource の説明を確認してください。各概念がユーザーによる Job の迅速な作成と追加に役立つかを見直します。ガイダンスが実行可能で、必要に応じて明確なリソースへのリンクがあり、不要な認知負荷を避けていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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
observationSourcealso 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".
- 主要言語
- MDX
- スター
- 527
- フォーク
- 480
- 平均マージ
- 1日 2時間
- マージ済み PR（30日）
- 97
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
smartcontractkit/documentation のほかの issue
-
[Bug]: broken link in onchain-write/submitting-reports-onchain対応中かも @Jludvim が 31 日前に担当しました。 オープンbug triage
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
smartcontractkit/documentation#4154 ·
メンテナーはふだん 1 日以内に返信
-
[Enhancement]: <Chainlink local documentation issue>対応中かも @ChrisWozniak が 31 日前に担当しました。 オープンenhancement triage
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
smartcontractkit/documentation#4114 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: <Possible to use multiple secret files from v2.4.0 onwards>対応中かも @ChrisWozniak が 31 日前に担当しました。 オープンbug triage
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
smartcontractkit/documentation#1505 ·
メンテナーはふだん 1 日以内に返信
-
GHA-data-validate-urls: Invalid URLs Detected対応中かも @khadni が今日担当しました。 オープンbug gh-action-data
smartcontractkit/documentation#4293 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
GHA-data-validate-urls: Invalid URLs Detected対応中かも @khadni が 7 日前に担当しました。 オープンbug gh-action-data
smartcontractkit/documentation#4267 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
smartcontractkit/documentation の issue をすべて見る
似ている issue
-
raised-by:reviewer
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
medici-finance/assay#2681 ·
メンテナーはふだん 1 日以内に返信
-
architecture desktop documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
docs pydanty:is-working
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
pydantic/pydantic-ai#10113 ·
メンテナーはふだん 1 日以内に返信
-
sオープン
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
microsoft/vscode-docs#10460 ·
メンテナーはふだん 1 日以内に返信
-
triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Portkey-AI/gateway#1844 ·
メンテナーはふだん 1 日以内に返信