Skip to content

[codex] Add Workflow Pause documentation#4729

Draft
JLDLaughlin wants to merge 1 commit into
mainfrom
codex/workflow-pause-docs
Draft

[codex] Add Workflow Pause documentation#4729
JLDLaughlin wants to merge 1 commit into
mainfrom
codex/workflow-pause-docs

Conversation

@JLDLaughlin

@JLDLaughlin JLDLaughlin commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Added a new Workflow Pause concept page under Encyclopedia > Workflows.
  • Linked the new page from the Workflow sidebar and Activity Operations page.
  • Updated Workflow Execution status docs to include Paused as an Open status.

Why

Workflow Pause needs public Pre-release documentation that explains when to use Pause and Unpause, what behavior users should expect, observability, limitations, and the relationship to Activity Operations.

Notes

  • This keeps Web UI content to support-surface/version wording only, matching the Activity Operations page pattern.
  • This does not modify generated CLI docs or shared lint/formatting config.

Validation

  • Ran git diff --check and git diff --cached --check.
  • Manually checked internal links for CLI anchors, release stage, support ticket, List Filter, Schedule, Cron Job, Child Workflows, Activity Operations, and Workflow Execution/Event History.
  • Did not run full Docusaurus build locally because this checkout does not have node_modules, yarn, or corepack available.

┆Attachments: EDU-6549 [codex] Add Workflow Pause documentation

@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

The `vercel.json` schema validation failed with the following message: should NOT have additional property `public`

Learn More: https://vercel.com/docs/concepts/projects/project-configuration

@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Error Error Jun 16, 2026 3:03am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

:::note Pre-release

Workflow Pause is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). In Temporal
Cloud, Pre-release access is invite-only; contact your Temporal account team or

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are we still planning on enabling this by default?

| [Pause](#pause) | Stops a Workflow Execution from making new progress. | [`temporal workflow pause`](/cli/command-reference/workflow#pause) |
| [Unpause](#unpause) | Resumes a Paused Workflow Execution. | [`temporal workflow unpause`](/cli/command-reference/workflow#unpause) |

## Pause {/* #pause */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can remove the comment here and for pause

### Scope

- Workflow Pause applies to a single Workflow Execution.
- It doesn't pause [Child Workflows](/child-workflows), Schedules, Task Queues, or Namespaces.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- It doesn't pause [Child Workflows](/child-workflows), Schedules, Task Queues, or Namespaces.
- It doesn't pause [Child Workflows](/child-workflows), Activities, Schedules, Task Queues, or Namespaces.

@spkane31 spkane31 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few small nits

@spkane31

Copy link
Copy Markdown
Contributor

I think we should add some information about billing for workflow pause / unpause. Specifically it would be good to say that when a workflow is paused it still incurs the cost of active storage.

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