Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document changes to exported records #13423

Closed
Tracked by #11456
korthout opened this issue Jul 11, 2023 · 1 comment
Closed
Tracked by #11456

Document changes to exported records #13423

korthout opened this issue Jul 11, 2023 · 1 comment
Assignees
Labels
component/exporter kind/documentation Categorizes an issue or PR as documentation related target:8.3 Issue must be completed before this target release

Comments

@korthout
Copy link
Member

korthout commented Jul 11, 2023

With command distribution, we have made several changes to the appended records. These changes will also be noticeable to exporters. We should document them in the update guide for 8.2 to 8.3.

The changes are:

  • introduced CommandDistribution value type
    • records of this value type can have intents:
      • STARTED (event)
      • DISTRIBUTING (event)
      • ACKNOWLEDGE (command)
      • ACKNOWLEDGED (event)
      • FINISHED (event)
    • records of this value type may have the following properties:
  • deprecated DeploymentDistribution value type
    • new deployments are distributed with CommandDistribution records
    • in progress DeploymentDistribution started before 8.3.0-alpha3 can still result in records of this value type

Open question
I'm unsure whether we need to document the newly introduced value type in the update guide. The deprecation should be documented there because it may break the expectations of exporters. Additions should be documented somewhere, but we have no place for this at this time.

@korthout korthout added kind/documentation Categorizes an issue or PR as documentation related component/exporter target:8.3 Issue must be completed before this target release labels Jul 11, 2023
@remcowesterhoud remcowesterhoud self-assigned this Oct 5, 2023
@remcowesterhoud
Copy link
Contributor

Done with camunda/camunda-docs#2703

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/exporter kind/documentation Categorizes an issue or PR as documentation related target:8.3 Issue must be completed before this target release
Projects
None yet
Development

No branches or pull requests

2 participants