Skip to content

Document that there can be multiple workers handling the receipts stream#18760

Merged
reivilibre merged 2 commits intodevelopfrom
bbz/improve-receipts-worker-documentation
Aug 4, 2025
Merged

Document that there can be multiple workers handling the receipts stream#18760
reivilibre merged 2 commits intodevelopfrom
bbz/improve-receipts-worker-documentation

Conversation

@benbz
Copy link
Copy Markdown
Member

@benbz benbz commented Aug 1, 2025

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct (run the linters)

Noticed when inspecting #18581 that some of the documentation was changed to highlight that there can be multiple workers handling the receipts stream & I'm aware of instances running multipe receipts workers. Document this on workers.md too as this is the primary resource for worker configuration

@benbz benbz requested a review from a team as a code owner August 1, 2025 11:08
@github-actions github-actions Bot deployed to PR Documentation Preview August 1, 2025 11:09 Active
Comment thread docs/workers.md Outdated
The following endpoints should be routed directly to the worker configured as
the stream writer for the `receipts` stream:
The `receipts` stream supports multiple writers. The following endpoints
can be handled by any worker, but should be routed directly one of the workers
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.

"should be routed directly one of the workers"
looks like theres a "to" missing

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Changed in ccedd56 along with the source that I copy/pasted from

@github-actions github-actions Bot deployed to PR Documentation Preview August 1, 2025 12:36 Active
@reivilibre reivilibre merged commit 8c71875 into develop Aug 4, 2025
38 checks passed
@reivilibre reivilibre deleted the bbz/improve-receipts-worker-documentation branch August 4, 2025 12:23
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.

3 participants