Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📖 Docs PR preview links
|
Removed section about Temporal Cloud support for Standalone Activities.
✅ Docs build passed |
Clarified the version requirement for Standalone Activities in the documentation.
ddacaeb to
f150996
Compare
Signed-off-by: Phil Prasek <prasek@gmail.com>
f150996 to
245f042
Compare
- Remove the Rust entry from the async-completion GET STARTED list in
activity-execution.mdx; the linked page doesn't exist for the Rust SDK.
This was failing the Docs Build Check.
- Retarget three /activities#... anchors (in activity-operations.mdx and
glossary.md) to the dedicated /workflow-activity and /standalone-activity
pages this PR introduces; the anchors they pointed to don't exist on the
overview page, which has no headings at all.
- Bump the Temporal CLI version requirement from v1.7.0 to v1.9.0 in the six
per-SDK Standalone Activities quickstart pages, matching the bump already
made elsewhere in this PR (standalone-activity.mdx, celery guide).
- Sentence-case two "Activity Options" headings and swap "vs." for "versus"
per Vale's Temporal.Headings and Std.Abbreviations.Latin suggestions.
- Fix a typo ("reccommend"), restore trailing newlines dropped by this PR's
edits, and remove a doubled blank line in glossary.md.
The six [SDK](.../standalone-activities#interruption-requests) links in
activity-operations.mdx's Reset section are left as still-broken: none of
the per-SDK standalone-activities.mdx pages have an "interruption requests"
section to link to. That needs either new content or a different target,
which needs the PR author's input rather than a guess.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Pause, Unpause, Reset, Terminate, Delete, Paused, Request Cancel, and Update Options are capitalized consistently as named Activity Operations throughout activity-operations.mdx (and, for Pause/Unpause/Reset/Terminate/ Delete, in pre-existing headings elsewhere: workflow-pause.mdx, cli-basics.mdx, namespaces.mdx), the same way Signal/Query/Update already get this treatment. Action/Actions is a defined Temporal Cloud term (see glossary.md) with the same pre-existing gap. None of these were actual sentence-casing mistakes; Vale was flagging established terms it didn't know about yet. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Removed references to SDKs for responding to interruption requests in Activity code.
Signed-off-by: Phil Prasek <prasek@gmail.com>
Signed-off-by: Phil Prasek <prasek@gmail.com>
| ``` | ||
|
|
||
| ### How to develop Activity Parameters {/* #activity-parameters */} | ||
| ### Activity Parameters {/* #activity-parameters */} |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Activity Parameters ****************************' should use sentence-style capitalization.
| ``` | ||
|
|
||
| ### How to develop Activity Parameters {/* #activity-parameters */} | ||
| ### Activity Parameters {/* #activity-parameters */} |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Activity Parameters ****************************' should use sentence-style capitalization.
| ``` | ||
|
|
||
| ### Develop Activity Parameters {/* #activity-parameters */} | ||
| ### Activity Parameters {/* #activity-parameters */} |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Activity Parameters ****************************' should use sentence-style capitalization.
| <!--SNIPEND--> | ||
|
|
||
| ## How to develop Activity Parameters {/* #activity-parameters */} | ||
| ## Activity Parameters {/* #activity-parameters */} |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Activity Parameters ****************************' should use sentence-style capitalization.
10b79dc to
39dbdde
Compare
Signed-off-by: Phil Prasek <prasek@gmail.com>
| ### Constraints {/* #activity-constraints */} | ||
|
|
||
| Activity Definitions are executed as normal functions. | ||
| ### Activity Parameters {/* #activity-parameters */} |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Activity Parameters ****************************' should use sentence-style capitalization.
|
Going to give this a full review today. |
Each sample was extracted verbatim into ~/src/temporalio-etc/workloads (temporal-workload-docs-activity-*) and run against a dev server. The failures: - Every feature guide offered `Status = 'Running'` as a List Filter example. The server rejects it: "invalid search attribute: status". The attribute is ExecutionStatus, as this branch's own search-attributes page documents. - The Go feature guide said GetActivityHandle requires RunID. It does not; omitting it targets the latest run, as in Java and Python. - The Java pages invoked `./temporal`, which does not exist after the `brew install temporal` the same page prescribes. Same in the Standalone Activity encyclopedia page. - The Java feature guide filtered on `ActivityType = 'composeGreeting'`. The Activity Type the server records is ComposeGreeting. - The TypeScript Worker hardcoded `namespace: 'default'` and the Client dropped `config.namespace`, so TEMPORAL_NAMESPACE was silently ignored and both connected to `default` -- contradicting the page's claim that the same code runs against Temporal Cloud unchanged. samples-typescript needs the same fix. - The Go quickstart's StartActivityOptions literal was not gofmt'd, having lost the comment that separates the alignment groups upstream. - The Celery guide printed `info.status`, an IntEnum, while showing `Completed` as the output. It prints `2`; `.name` gives COMPLETED. Not changed, but worth a look: the .NET page shows three different top-level programs all titled Program.cs, none of which dispatches on the `worker` / `execute-activity` arguments the page tells you to pass, whereas upstream Program.cs is one program with a switch; and the Celery guide asks for temporalio>=1.23.0 where the SAA pages require 1.33.0.
Signed-off-by: Phil Prasek <prasek@gmail.com>
| ## What is an Activity Execution? {/* #activity-execution */} | ||
|
|
||
| An Activity Execution is the full chain of [Activity Task Executions](/tasks#activity-task-execution). | ||
| When an Activity caller starts an [Activity](/activities), an Activity Execution is created that orchestrates its full lifecycle, including retries. |
There was a problem hiding this comment.
This could be a clearer definition. I'll update this.
|
@copilot resolve the merge conflicts in this pull request |
There was a problem hiding this comment.
Will need to double check if this is referenced anywhere. But good with removing this for now.
|
|
||
| #### What a Heartbeat Timeout of `0s` means {/* #heartbeat-timeout-zero */} | ||
|
|
||
| `0s` means the Heartbeat Timeout is disabled. No Heartbeat timer is started, so the Activity never fails for missing a Heartbeat. It does not mean an unbounded timeout, and it does not mean the Activity times out immediately. |
There was a problem hiding this comment.
Tone can be changed - a bit hard to read.
# Conflicts: # docs/demos/standalone-activities.mdx # docs/develop/go/activities/standalone-activities.mdx # docs/develop/java/activities/standalone-activities.mdx # docs/encyclopedia/activities/activity-operations.mdx # docs/encyclopedia/activities/standalone-activity.mdx # docs/evaluate/development-production-features/job-queue.mdx Co-authored-by: jsundai <36107423+jsundai@users.noreply.github.com>
Resolved and merged |
| description: | ||
| Understand Temporal Activities, including Activity Definitions, Types, Executions, idempotency, cancellations, Local Activities, and | ||
| Standalone Activities. | ||
| Learn how Temporal turns a plain function you write into a Temporal Activity and durably executes it as a Workflow step or background job. |
There was a problem hiding this comment.
The Encyclopedia is where there are larger changes so will need to come back to this section.
|
|
| --- | ||
| id: index | ||
| title: Activity Operations | ||
| description: Learn how to manage a running Activity Execution with commands to Pause, Unpause, Reset, Update Options, Request Cancel, Terminate, and Delete. |
There was a problem hiding this comment.
"Learn" is used frequently in the description. This could be dropped across the descriptions - the rest of the sentence is fine.
| id: local-activity | ||
| title: Local Activity | ||
| description: Learn about Local Activities in Temporal, how they work, when to use them, and how they differ from regular Activities. | ||
| description: Learn about Local Activities that run in the same Worker process as the Workflow that schedules it, trading full durability for lower latency and a smaller Event History. |
There was a problem hiding this comment.
trading full durability sounds a bit odd to me.
| [Client](/encyclopedia/temporal-client), without using a Workflow. | ||
|
|
||
| ## What is a Standalone Activity? {/* #standalone-activity */} | ||
| **Standalone Activities are Temporal's [job queue](/evaluate/development-production-features/job-queue)** - the |
There was a problem hiding this comment.
I don't think it really needs to be in bold. But it's a smaller nit.
|
|
||
| Standalone Activities are Temporal’s [job queue](/evaluate/development-production-features/job-queue) - | ||
| the simplest way to run durable, retryable tasks on Temporal. | ||
| ## Coming from another job queue? {/* #coming-from-another-job-queue */} |
There was a problem hiding this comment.
Can change this from a question to a statement. Smaller nit
| id: activity-execution | ||
| title: Activity Execution | ||
| description: Understand how Activity Executions work in Temporal, including retries, timeouts, and failure handling. | ||
| description: Learn how to start an Activity as a durable Activity Execution with built-in retries, timeouts, and failure handling. |
There was a problem hiding this comment.
Let's drop the "Learn" from the descriptions.
What does this PR do?