update C4 container diagram and add component diagram containing Info… #65
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
…rmation and Knowledge Layer Server Signed-off-by: Christian Muehlbauer <[email protected]>
chrizmc
force-pushed
the
update-and-add-c4-level-svgs
branch
from
79f67e8 to
2a23b34
Compare
slawr
reviewed
Jan 30, 2025
There was a problem hiding this comment.
Great to see the KL and IL components diagrammed. I think it will help people understand the coming new features.
Review comments:
- Medium
- The KL + IL Component diagram can be read stand alone, however there is a challenge to merge the updated Container diagram as the containers it introduces are not yet in the Playground, e.g. linking to it in the online document before KL is merged could be confusing. We could perhaps rename it to make this clear to allow merging.
- There are some spelling errors, e.g. "reporesenting" in the Container diagram
- In the Container diagram the Container titles are currently logical, e.g. Timeseries DB Server, or VISS Server followed by the technology. In this PR the title for the Realm DB Container is Realm. We should either align the Realm container title or discuss whether the existing approach should be changed.
- Minor
- Capitalization is inconsistent. Whilst existing sentences start with a capital letter, many in the area of the KL server do not.
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.
…rmation and Knowledge Layer Server