Document how to do inter-partition communication #10083
Merged
Conversation
This file contains 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
This tries to explain how we want to do inter-partition communication, and why it should be done this way.
pihme
suggested changes
Aug 16, 2022
docs/developer_handbook.md
Outdated
|
|
||
| As we've seen, the sending partition may send a command many times to another partition. So, the engine must be able to deal with these redundant commands (i.e. commands that are sent many times). To be specific, the engine must process commands received from another partition idempotently. | ||
|
|
||
| :::info |
There was a problem hiding this comment.
❌ this is not rendered correctly (see https://github.com/camunda/zeebe/blob/korthout-doc-interpartition-communication/docs/developer_handbook.md)
There was a problem hiding this comment.
Interesting. I've found that GH supports info blocks in the form of block quotes (beta feature that may be subject to change).
That looks like this:
Note
So information, much wow!
There is a discussion ongoing about supporting the :::info\n...\n:::syntax.
GH markdown syntax now supports info and warning blocks in the form of blockquotes. This is silly because the rest of the internet uses the ::: syntax. But at least this is rendered by GH. See community/community#16925
korthout
force-pushed
the
korthout-doc-interpartition-communication
branch
from
96833cd
to
dd2d438
Compare
remcowesterhoud
approved these changes
Aug 17, 2022
saig0
approved these changes
Aug 18, 2022
|
bors merge |
|
Build succeeded: |
zeebe-bors-camunda
bot
deleted the
korthout-doc-interpartition-communication
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
During our team meeting, we discussed that we wanted to document how we do (and want to do) inter-partition communication.
This is an attempt to document how we want to do inter-partition communication, and why it should be done this way.
Related issues
relates to #10064
Definition of Done
Not all items need to be done depending on the issue and the pull request.
Code changes:
backport stable/1.3) to the PR, in case that fails you need to create backports manually.Testing:
Documentation:
Please refer to our review guidelines.