prefect icon indicating copy to clipboard operation
prefect copied to clipboard

Added state change diagram

Open mthatt opened this issue 1 year ago • 4 comments

This state change diagram should help users visualize how states transition in Prefect. mermaid.js is ordering the states strangely with mintlify, particular the section with 'AwaitingRetry' and 'Retrying' on the left.

Checklist

  • [ ] This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • [ ] If this pull request adds new functionality, it includes unit tests that cover the changes
  • [ ] If this pull request removes docs files, it includes redirect settings in mint.json.
  • [ ] If this pull request adds functions or classes, it includes helpful docstrings.

mthatt avatar Nov 01 '24 05:11 mthatt

Thank you, @mthatt. The Mintlify preview deploy doesn't seem to be following, so not able to see a rendered version of the diagram. Are you able to add a screenshot from local?

discdiver avatar Nov 01 '24 12:11 discdiver

Screenshot 2024-11-01 at 5 40 55 PM

Here's a screenshot of how it looks in docs

mthatt avatar Nov 01 '24 21:11 mthatt

Cool! Re: the suboptimal retry placement. I'm not sure, but maybe it can be managed explicitly with divs?

discdiver avatar Nov 04 '24 15:11 discdiver

If it can't be changed easily, I think this chart provides good value. Approving.

discdiver avatar Nov 13 '24 13:11 discdiver

one small request for a wording update, otherwise this is pretty helpful thank you

I accepted your change @cicdw, if you want to approve we can merge.

discdiver avatar Nov 18 '24 18:11 discdiver

This pull request is stale because it has been open 14 days with no activity. To keep this pull request open remove stale label or comment.

github-actions[bot] avatar Dec 02 '24 19:12 github-actions[bot]

This pull request is stale because it has been open 14 days with no activity. To keep this pull request open remove stale label or comment.

github-actions[bot] avatar Dec 31 '24 06:12 github-actions[bot]

Closed as completed in another PR.

discdiver avatar Dec 31 '24 15:12 discdiver