Introduce C4 Model diagrams to CDSP #62
Merged
Conversation
This file contains hidden or 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
slawr
added
documentation
3 tasks
After discussion in the Data Architecture team meetings (see Sept-Nov minutes) the C4 Model (www.c4model.com) was adopted for visualising the Playground s/w architecture. This commit introduces the top two levels of abstraction: 1. The level 1 System context diagram which shows how the Playground is related to the surrounding software systems with which it communicates. 2. The level 2 Container diagram which shows the containers (C4 model term) which make up the Playground. Integration note: Source for these diagrams was the working file used in the team discussions currently hosted in the group google drive as CDSP-C4-Model.drawio.svg. That file has multiple tabs, each holding a diagram. The tabs were exported to separate files to make referencing diagrams easier. Signed-off-by: Stephen Lawrence <[email protected]>
To help people navigating the sources reference the assets folder in the online documentation tree as another source of diagrams. Signed-off-by: Stephen Lawrence <[email protected]>
slawr
force-pushed
the
introduce-c4-model
branch
from
ec9e5eb to
a8164ad
Compare
slawr
changed the title
Collaborator
Author
|
Removed WIP from title. PR is ready for review for possible merging. @chrizmc would you like to take this on as your first review and merge? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
WIP do not merge without first talking to the originatorAfter discussion in the Data Architecture team meetings (see Sept-Nov) the C4 Model was adopted for discussing and communicating the Playground s/w architecture.
As a starting point introduce the diagram files to the source base for reference.