Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
zeuslawyer opened this issue May 27, 2022 · 0 comments
Labels
Chainlink Nodes enhancement Enhance existing content or processes

Comments

@zeuslawyer
Copy link
Contributor

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".

@zeuslawyer zeuslawyer added enhancement Enhance existing content or processes triage labels May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Chainlink Nodes enhancement Enhance existing content or processes
Projects
None yet
Development

No branches or pull requests

2 participants