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.

Sign up for GitHub

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

Jump to bottom

Added state change diagram #15899

Closed
wants to merge 75 commits into from
Closed

Added state change diagram #15899

wants to merge 75 commits into from

Conversation

mthatt
Copy link
Contributor

@mthatt mthatt commented Nov 1, 2024

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.

@github-actions github-actions bot added the docs label Nov 1, 2024
@discdiver
Copy link
Contributor

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?

@mthatt
Copy link
Contributor Author

mthatt commented Nov 1, 2024

Screenshot 2024-11-01 at 5 40 55 PM

Here's a screenshot of how it looks in docs

@discdiver
Copy link
Contributor

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

@discdiver
Copy link
Contributor

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

cicdw
cicdw requested changes Nov 13, 2024
View reviewed changes
Copy link
Member

@cicdw cicdw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@discdiver discdiver requested a review from cicdw November 16, 2024 15:11
@discdiver
Copy link
Contributor

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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 2, 2024

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.

desertaxle and others added 12 commits December 16, 2024 23:48
@desertaxle @mthatt
Set COVERAGE_CORE=sysmon to speed up test on 3.12 (PrefectHQ#15905)
9f0dbff
@zzstoatzz @mthatt
fix wait_for for DaskTaskRunner (PrefectHQ#15909)
93059f8
@discdiver @mthatt
Adds notes to settings docs on when features were added (PrefectHQ#15910
ed98385 
)
@sam-phinizy @mthatt
Add in WorkerAPILogger and related functionality (PrefectHQ#15864)
621bf0c
@zzstoatzz @mthatt
fix extra loggers parsing (PrefectHQ#15913)
bb0c9a1
@zzstoatzz @mthatt
add internal async_dispatch util (PrefectHQ#15813)
844c377
@discdiver @mthatt
Fix table formatting in Roles doc (PrefectHQ#15918)
6b65e55
@marvin-robot @mthatt
Update @prefecthq/prefect-ui-library to version 3.11.14 (PrefectHQ#15921
75703e4 
)

Co-authored-by: marvin-robot <[email protected]>
@dependabot @mthatt
Bump vue-tsc from 2.1.8 to 2.1.10 in /ui (PrefectHQ#15916)
559bb35 
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@desertaxle @aaazzam @mthatt
Begin replatform of UI to React (PrefectHQ#15907)
dad8b0e 
Co-authored-by: Adam Azzam <[email protected]>
@mthatt
Send worker metadata with first heartbeat (PrefectHQ#15898)
caff9d0
@GalLadislav @mthatt
Fix prefect config view not showing .env file settings (PrefectHQ#1…
ea07a84 
…5922)
marvin-robot and others added 14 commits December 16, 2024 23:48
@marvin-robot @mthatt
Update @prefecthq/prefect-design to version 2.14.11 (PrefectHQ#16028)
fc7d1d7 
Co-authored-by: marvin-robot <[email protected]>
@mthatt
Remove experimental worker logs setting (PrefectHQ#16024)
651315d 
Worker logs are no longer experimental, so this PR removes references to the setting. We still want to avoid sending worker logs to open-source API servers until they support worker logs, though, so we use the existence of a backend_id on worker logs as a proxy for whether or not the worker is connected to Cloud. (Only workers connected to Cloud emit logs with worker IDs attached.)
@jdjfisher @mthatt
fix worker not releasing limit slot on failed propose pending state (P…
6239586 
…refectHQ#16012)
@matmiad @mthatt
refactor: gcp cloud run v2 extend env vars and fix cloud sql (Prefect…
b91527f 
…HQ#16026)
@marvin-robot @mthatt
Update @prefecthq/prefect-ui-library to version 3.11.19 (PrefectHQ#16029
bae6a76 
)

Co-authored-by: marvin-robot <[email protected]>
@desertaxle @mthatt
[UI v2] Fix tab order in variable create dialog (PrefectHQ#16014)
d3e43d4
@desertaxle @mthatt
[UI v2] Variables table - part 2 (PrefectHQ#16025)
2f8ddab
@discdiver @mthatt
Update links in blocks to not point to docs from archived repositories (
5236259 
PrefectHQ#16031)
@jlowin @mthatt
Move installation notes to bottom of self-host doc (PrefectHQ#16034)
1d41315
@kevingrismore @mthatt
Add new action to OpsGenieWebhook for apprise==1.9.0 compatibil…
ec67f4d 
…ity (PrefectHQ#16030)
@discdiver @zzstoatzz @mthatt
Briefly explain how to update deployment with prefect.yaml (Prefect…
4afec9e 
…HQ#15812)

Co-authored-by: nate nowack <[email protected]>
@dependabot @mthatt
Bump tailwindcss from 3.4.14 to 3.4.15 in /ui (PrefectHQ#16040)
36d5711 
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @mthatt
Bump @vitejs/plugin-vue from 5.1.4 to 5.2.0 in /ui (PrefectHQ#16039)
f8ddc80 
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @mthatt
Bump vite from 5.4.10 to 5.4.11 in /ui (PrefectHQ#16038)
da4448e 
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@mthatt mthatt force-pushed the state-diagram-update branch from 43f7b1b to da4448e Compare December 17, 2024 05:49
@github-actions github-actions bot added upstream dependency An upstream issue caused by a bug in one of our dependencies migration ui-replatform Related to the React UI rewrite labels Dec 17, 2024
@mthatt mthatt removed upstream dependency An upstream issue caused by a bug in one of our dependencies migration ui-replatform Related to the React UI rewrite labels Dec 17, 2024
@mthatt mthatt enabled auto-merge (squash) December 17, 2024 05:59
@github-actions GitHub Actions
Copy link
Contributor

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.

@discdiver discdiver closed this Dec 31, 2024
auto-merge was automatically disabled December 31, 2024 15:04

Pull request was closed

@discdiver
Copy link
Contributor

Closed as completed in another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@discdiver discdiver discdiver approved these changes

@desertaxle desertaxle Awaiting requested review from desertaxle desertaxle is a code owner

@zzstoatzz zzstoatzz Awaiting requested review from zzstoatzz zzstoatzz is a code owner

@cicdw cicdw Awaiting requested review from cicdw cicdw is a code owner

@aaazzam aaazzam Awaiting requested review from aaazzam aaazzam is a code owner

@chrisguidry chrisguidry Awaiting requested review from chrisguidry chrisguidry is a code owner

@znicholasbrown znicholasbrown Awaiting requested review from znicholasbrown znicholasbrown is a code owner

Assignees
No one assigned
Labels
docs status:stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.