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

Breakout workflow pg #3194

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Breakout workflow pg #3194

wants to merge 9 commits into from

Conversation

jsundai
Copy link
Contributor

@jsundai jsundai commented Nov 4, 2024

What does this PR do?

  • reorganized workflow content: splits the lengthy Workflow page into focused sub-pages for easier navigation, improved readability, less cognitive load, and better SEO.
  • supports future expansion: this structure allows adding details to specific topics without overcrowding a single page.
  • started with some of the longest pages in the encyclopedia

Notes to reviewers

Was split as of now for the sake of poc and based on the heading levels on the workflow page.
Links will need to be changed and any redirects - might be complex.
Descriptions need to be changed.

@jsundai jsundai requested a review from a team as a code owner November 4, 2024 18:12
@jsundai jsundai marked this pull request as draft November 4, 2024 18:12

When a Schedule triggers a Workflow that completes successfully and yields a result, the result from the initial Schedule execution can be accessed by the subsequent scheduled execution through `LastCompletionResult`.

Be aware that if, during the subsequent run, the Workflow employs the [Continue-As-New](#continue-as-new) feature, `LastCompletionResult` won't be accessible for this new Workflow iteration.
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI -- this content appears to be missing from this PR


Be aware that if, during the subsequent run, the Workflow employs the [Continue-As-New](#continue-as-new) feature, `LastCompletionResult` won't be accessible for this new Workflow iteration.

It is important to note that the [status](#status) of the subsequent run is marked as `Continued-As-New` and not as `Completed`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This anchor too


The execution semantics of a Workflow Execution include the re-execution of a Workflow Function, which is called a [Replay](#replays).
The use of Workflow APIs in the function is what generates [Commands](#command).
Commands tell the Temporal Service which Events to create and add to the Workflow Execution's [Event History](#event-history).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is the missing page that should contain continue as new

@axfelix
Copy link
Contributor

axfelix commented Nov 20, 2024

@jsundai Anchors are fixed, there's some content missing (possibly just one page, maybe more) but this should be a lot closer to shippable now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants