Document instance migration phases 3 and 4 #4348
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
With 8.6, instance migration will have a few more error cases to ensure process instances are always migrated correctly.
With 8.6, instance migration will have a few more limitations to ensure process instances are always migrated correctly.
Boundary events can now be mapped in instance migrations. This results in migrating the associated subscription. While this change adjusts the limitations and notes that this mapping was not supported, it does not yet provide an example to showcase the behavior.
This is not finished yet, but adds a first section for dealing with catch events. Co-authored-by: berkaycanbc <124141078+berkaycanbc@users.noreply.github.com>
|
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
Co-authored-by: Nico Korthout <nico.korthout@camunda.com>
This section can also be moved to another page
berkaycanbc
changed the title
These headers should all be H3 under the H2 header for supported elements. This ensures they're displayed as part of rather than their own sections.
The concept page should focus on what users can achieve with this feature (the concept) and how to use it. The limitations are in the bottom so it doesn't distract from teaching the reader about the concept. Which elements are supported is just further clarifying the limitations and capabilities.
Move the headers so it's part of rather than separate sections.
berkaycanbc
force-pushed
the
korthout-22680-document-instance-migration-phases-4-and-5
branch
from
b759a4d
to
1a3a695
Compare
korthout
commented
Oct 1, 2024
There was a problem hiding this comment.
Thanks @berkaycanbc 🚀
👍 Lots of good changes. I've shared some suggestions to further improve this, but I think this is pretty solid.
❌ We should update the limitations section, e.g. it still mentions detaching boundary events instead of the more general catch events.
💭 Some additional thoughts:
- I wonder if some of the sections are too wordy. Can we condense it a bit to avoid losing readers?
- I wonder whether we need to clarify the internals a bit better near the start like the C7 docs do:
- what do we actually do when migrating, i.e. change some properties like
processDefinitionKey,bpmnProcessId,version, andelementId - what happens when a migration is rejected? (example for modification)
- what do we actually do when migrating, i.e. change some properties like
docs/components/concepts/assets/bpmn-symbols/business-rule-task.svg
Outdated
Show resolved
Hide resolved
| @@ -858,9 +858,11 @@ Returned if: | |||
| - Not all active elements in the given process instance are mapped to the elements in the target process definition | |||
| - A mapping instruction changes the type of an element or event | |||
| - A mapping instruction changes the implementation of a task | |||
| - A mapping instruction detaches a boundary event from an active element | |||
There was a problem hiding this comment.
❌ We still need adjust this to cover all catch events
Suggested change
| - A mapping instruction detaches a boundary event from an active element | |
| - A mapping instruction detaches a catch event from an active element |
There was a problem hiding this comment.
@korthout this limitation was outdated as I added an example after it. I refactored it to catch events in general but keep the example for boundary event. Please take another look. 👀
berkaycanbc
force-pushed
the
korthout-22680-document-instance-migration-phases-4-and-5
branch
from
9770415
to
43a94fb
Compare
berkaycanbc
force-pushed
the
korthout-22680-document-instance-migration-phases-4-and-5
branch
from
0f958c0
to
075dcc8
Compare
|
@mesellings, I just sent final commits to simplify things and re-organize limitations. Also, I added details about rejection cases to RPC docs. |
mesellings
previously approved these changes
Oct 4, 2024
There was a problem hiding this comment.
@korthout Lgtm - just some minor (non-blocking) suggestions and grammatical issues I spotted. I think we could split some of the long paragraphs into bulleted lists for readability/scanning, but that can be done at a later date. Great work 👍 🚀
Thanks for the review @mesellings! I applied all of your suggestions. 🚀 Could you please specify which paragraphs you would prefer to convert into bulleted lists? |
korthout
commented
Oct 7, 2024
There was a problem hiding this comment.
Thanks for all the great improvements and changes @berkaycanbc
I had some final comments that I wanted to share
korthout
commented
Oct 7, 2024
Co-authored-by: Nico Korthout <korthout@users.noreply.github.com>
Co-authored-by: Nico Korthout <korthout@users.noreply.github.com>
berkaycanbc
deleted the
korthout-22680-document-instance-migration-phases-4-and-5
branch
|
🧹 Preview environment for this PR has been torn down. |
christinaausley
pushed a commit
that referenced
this pull request
Oct 7, 2024
* docs: add new instance migration grpc error cases With 8.6, instance migration will have a few more error cases to ensure process instances are always migrated correctly. * docs: add new instance migration limitations With 8.6, instance migration will have a few more limitations to ensure process instances are always migrated correctly. * docs: lift no-mapped boundary events limitation Boundary events can now be mapped in instance migrations. This results in migrating the associated subscription. While this change adjusts the limitations and notes that this mapping was not supported, it does not yet provide an example to showcase the behavior. * wip: add section for dealing with catch events This is not finished yet, but adds a first section for dealing with catch events. * docs: document migrating catch events * docs: enrich the section for handling catch events * docs: move the section for handling catch events up * docs: add supported bpmn elements section This section can also be moved to another page * docs: change supported elements headers These headers should all be H3 under the H2 header for supported elements. This ensures they're displayed as part of rather than their own sections. * docs: move supported elements to limitations The concept page should focus on what users can achieve with this feature (the concept) and how to use it. The limitations are in the bottom so it doesn't distract from teaching the reader about the concept. Which elements are supported is just further clarifying the limitations and capabilities. * docs: move supported elements under limitations Move the headers so it's part of rather than separate sections. * docs: add first set of visuals for handling catch events * docs: update image to the correct one * docs: add more visuals for handling catch events * docs: add more visuals for handling catch events * docs: use event subprocess visual for add/remove catch event * docs: fix links to the support bpmn elements * docs: add link to REST API * docs: update same message name tip * docs: add example for boundary event detachment * docs: simplify limitations section * docs: add another catch event limitation * docs: use existing bpmn symbol SVGs * docs: move changing the process instance state discussion to intro * docs: add supported bpmn elements to limitations section * docs: remove old comment * docs: remove excessive sentence * docs: remove unnecessary section * docs: emphasize catch event limitation in general * docs: apply suggestions from code review * docs: add limitations for multi-instance body * docs: add operational semantics * docs: clarify what happens if migration fails * docs: simplify catch event behaviour explanations * docs: simplify internal execution explanations * docs: group limitations section * docs: add more rejection cases to RPC docs * docs: add message subscription limitation * docs: apply suggestions from tech writer review --------- Co-authored-by: Nico Korthout <korthout@users.noreply.github.com>
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
closes camunda/camunda#22680
When should this change go live?
holdlabel or convert to draft PR)WIP
PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).WIP