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

Fix links in triggers page #513

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Fix links in triggers page #513

merged 1 commit into from
Jul 2, 2024

Conversation

josephjclark
Copy link
Contributor

Here's what https://docs.openfn.org/documentation/build/triggers looks like right now:

image

The "Managing State" and "Keep a cursor" sections don't link anywhere and aren't on the page.

This was pointed out by a user over in OpenFn/adaptors#654 (comment)

Looking at the legacy docs it looks things have been moved around and these got left hanging.

So I've made a few changes:

  • Link the cursor stuff to the job writing guide bit on cursors
  • Link to some state management stuff for triggers (although to be fair I don't think it's a very useful link)
  • Removed some bullet points which I didn't think were very helpful
  • Used Proper Nouns instead of "quotes" for jargon like Webhook Event, which looks a little bit less like we're making up words
  • Adjusted the page structure to be a bit more useful

@josephjclark
Copy link
Contributor Author

@taylordowns2000 @aleksa-krolls maybe either of you could check and merge this please :)

@taylordowns2000 taylordowns2000 merged commit f8863a2 into main Jul 2, 2024
1 check passed
@josephjclark josephjclark deleted the cron-cursor-docs branch July 2, 2024 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants