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

Data flow diagram updates - Spring Kafka related #140

Merged
merged 16 commits into from
Dec 30, 2024

Conversation

mcook42
Copy link

@mcook42 mcook42 commented Dec 30, 2024

PR Details

Description

Updates to the data flow diagrams related to the recent Spring Kafka migration work. The files with the drawio extension were also deleted since Drawio editors can edit the PNG directly. Keeping both around was cumbersome, and the PNG files were more usable anyway (you don't need special editors/tools/parsers to view a PNG).

Related Issue

Motivation and Context

These diagram updates weren't performed during the related code changes in #118, #116, #123, #129, #131 and #134.

How Has This Been Tested?

These do not effect the code, so they were not tested.

Types of changes

  • Documentation update
  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    ODE Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Draw.io supports editing the generated .png file directly, so including both files is redundant and can risk drift between the two leading to inaccuracy
Draw.io supports editing the generated .png file directly, so including both files is redundant and can risk drift between the two leading to inaccuracy
Refreshed the diagram to reflect recent changes in the data flow. Ensures documentation remains accurate and aligned with the current system.
@mcook42 mcook42 marked this pull request as ready for review December 30, 2024 17:41
Copy link
Member

@dmccoystephenson dmccoystephenson left a comment

Choose a reason for hiding this comment

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

Some diagrams and their descriptions have discrepancies, and a few pieces of information are missing. I've provided several comments to highlight these points. While some issues were pre-existing and not directly tied to the Spring Kafka migration, addressing them now could improve overall clarity and accuracy.

Copy link
Member

@dmccoystephenson dmccoystephenson left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@mcook42 mcook42 merged commit db4b514 into dev Dec 30, 2024
3 checks passed
@mcook42 mcook42 deleted the mcook42/spring-kafka/data-flow-diagram-updates branch December 30, 2024 23:24
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