Skip to content

docs: add encyclopedia page for external storage#4380

Merged
lennessyy merged 3 commits intolarge-payload-prereleasefrom
feat/encyclopedia-external-storage
Apr 4, 2026
Merged

docs: add encyclopedia page for external storage#4380
lennessyy merged 3 commits intolarge-payload-prereleasefrom
feat/encyclopedia-external-storage

Conversation

@lennessyy
Copy link
Copy Markdown
Contributor

@lennessyy lennessyy commented Apr 2, 2026

Summary

  • Add new encyclopedia page for external storage (claim check pattern) under data conversion
  • Add data converter flow diagram with external storage SVG
  • Add sidebar entry for the new external storage page

This is PR 2 of 3, split from #4333.

Test plan

  • Verify the new external storage page renders correctly
  • Verify the SVG diagram displays properly
  • Verify the sidebar entry appears in the correct position under Data conversion

🤖 Generated with Claude Code

┆Attachments: EDU-6150 docs: add encyclopedia page for external storage

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@lennessyy lennessyy requested a review from a team as a code owner April 2, 2026 01:25
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 2, 2026

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

Project Deployment Actions Updated (UTC)
temporal-documentation Error Error Apr 2, 2026 11:39pm

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

📖 Docs PR preview links

Copy link
Copy Markdown
Contributor

@drewhoskins-temporal drewhoskins-temporal left a comment

Choose a reason for hiding this comment

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

This is great, thanks for all the improvements.

A few final things I noticed.

payloads from external storage in parallel, then passes them back through the Payload Codec and Payload Converter to
reconstruct the original data.

The SDK parallelizes uploads and downloads to minimize latency. When a single Workflow Task involves multiple payloads
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.

nit: felt like you repeated yourself in this paragraph.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The second sentence explains what parallelization means for this context. Not every reader will know what "parallelizes uploads and downloads" implies practically, so the follow-up makes it concrete. And if they do know, they can read the first sentence and skim or skip the rest. Happy to tighten the wording if it feels redundant, but I'd keep the explanation itself.

Comment on lines +86 to +87
If the external store is temporarily unreachable during an upload or download, the operation fails the Workflow Task.
Temporal automatically retries failed Workflow Tasks, so the operation resumes when the store becomes available again.
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.

This is only true when the storage is uploaded from a workflow task. Payloads can come from users' clients, outside the workflow. Maybe just cut this for now?

Co-authored-by: Drew Hoskins <drew.hoskins@temporal.io>
@lennessyy lennessyy changed the base branch from main to feat/large-payload-storage April 4, 2026 00:11
@lennessyy lennessyy changed the base branch from feat/large-payload-storage to main April 4, 2026 00:11
@lennessyy lennessyy changed the base branch from main to large-payload-prerelease April 4, 2026 00:14
@lennessyy lennessyy merged commit d5d032b into large-payload-prerelease Apr 4, 2026
9 of 10 checks passed
@lennessyy lennessyy deleted the feat/encyclopedia-external-storage branch April 4, 2026 00:15
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