docs: refresh all documentation for *job.Definition convergence#21
Merged
Conversation
- container/README.md: add builder-first quick example showing NewWorkflowBuilder().Name(...).Single().Build() → *job.Definition; retain low-level ExecuteWorkflow path; link to docs/job-definition.md - function/README.md: replace quick example with NewFunctionBuilder() chain (.Name/.Activity/.Single/.Add/.Build); link to docs/job-definition.md - datasync/README.md: show Build() returning *job.Definition; add datasync/chunk/ section with NewDateChunkedSync example and schedule methods; link to docs/job-definition.md - examples/container/README.md: update section 12 (builder-advanced.go) to remove BuildSingle() reference and describe Build() → *job.Definition - examples/function/README.md: replace deprecated BuildPipeline/BuildParallel/ BuildSingle table with current .Pipeline()/.Parallel()/.Single()+.Build() API - examples/datasync/README.md: add chunk_basic.go entry (section 5) and running command
All builders now return (*job.Definition, error) from Build(). Update README, INSTRUCTION, getting-started, and architecture docs to reflect the new temporal.NewClient 2-return signature, the unified job.Definition API, datasync/chunk and datasync/internal/heartbeat packages, and the removal of FullJobRegistration and the old multi-method builder patterns.
- datasync-workflows.md: Builder section updated to show Build() returning *job.Definition; worker setup uses def.Register/def.Execute/def.ApplySchedule; removed FullJobRegistration/BuildJobRegistration; added chunk cross-link. - container-workflows.md: Builder section updated to show NewWorkflowBuilder() (no name arg), Name/mode setters, Build() -> *job.Definition, def.Register pattern; worker setup section split into builder-based and manual paths; noted RegisterAll idempotency. - function-workflows.md: Builder section updated to show NewFunctionBuilder(), required Name/Activity setters, mode setters, Build() -> *job.Definition; worker setup section split into builder-based and manual paths. - docs/chunk-workflows.md: New guide for datasync/chunk package covering ChunkedSync and DateChunkedSync builders, Partition/PartitionFetcher/ ProgressTracker interfaces, resumable backfills, ContinueAsNew, rate-limit retry, and scheduling. - docs/job-definition.md: New guide for *job.Definition from pkg/v2/temporal/job covering registration, execution, per-run lifecycle, per-job aggregates, ScheduleSpec, Registry, and direct construction.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive doc refresh after the recent pkg/temporal/job + builder convergence work. Three commits, ~25 files touched.
Top-level entrypoints (
bc9e487)README.md,INSTRUCTION.md,docs/getting-started.md,docs/architecture.mdtemporal.NewClientcalls updated to 2-return signature*job.Definitionpatterndatasync/chunk/anddatasync/internal/heartbeat/Workflow guides + new docs (
2c38ceb)docs/datasync-workflows.md,docs/container-workflows.md,docs/function-workflows.md— builder sections rewrittendocs/chunk-workflows.md(~270 lines)docs/job-definition.md(~240 lines)Package + example READMEs (
ca45231)Verified
FullJobRegistration/ 3-return NewClient / old Build*() referencesdocs:commit type = no semantic-release version bump