-
Notifications
You must be signed in to change notification settings - Fork 18
docs: update cron trigger runs description #711
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good @hunterachieng
final output state of the **last succesful run** for this workflow. This allows | ||
each subsequent run to _know_ about previous runs—i.e., you can pass information | ||
from one run to another even if they happen days apart. | ||
#### What are cron jobs? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this appropriate for this section of docs?
We're deep in an explanation of state here. I don't think this is the time or place to explain what a cron job is. We could add a single sentence definition, but otherwise we should link to the full cron docs.
Otherwise I think this is just a distraction from the discussion on this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels like the main docs? https://docs.openfn.org/documentation/build/triggers#cron-triggers-formerly-timers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@josephjclark In the link you have shared, the explanation still links to the docs we are currently updating to explain about state in cron jobs.
If readers are being directed to these docs, should we go deeper into state in cron jobs?

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But that's only for state specifically.
"What is a cron job and how does it work" needs to be answered on build/triggers
. I think those docs are fine right now but I'm open to discussing improvements.
"What is the input state passed into my cron job" needs to be explained in-depth in jobs/state. This stuff about "the output of the trigger step will be the input to the next step". It might need a concerete worked example to explain it.
build/triggers
can have a single-sentence explanation of how state works, then link to jobs/state
for more detail
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have explained more about the state in jobs/state
with the new discovery of how state works in cronjobs
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Short Description
Update cron trigger runs description to make it easy to understand
Closes #680
Details
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy