-
Notifications
You must be signed in to change notification settings - Fork 449
docs: issue530 backend visualisation #568
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
Open
mtreacy002
wants to merge
1
commit into
anitab-org:develop
Choose a base branch
from
mtreacy002:issue530-add-diagram-to-visualise-backend
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Backend System Visualisation | ||
|
|
||
| This diagram will give you a quick overview of what the backend system looks like. | ||
|
|
||
| ## What does the integration look like? | ||
|  | ||
|
|
||
| ## Classes mapping | ||
|  | ||
|
|
||
| ### - Data persistence layer | ||
|
|
||
|  | ||
|
|
||
| ### - Data access layer | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ### - Service layer | ||
|
|
||
| - #### user.py | ||
|
|
||
|  | ||
|  | ||
|  | ||
|
|
||
| - #### admin.py | ||
|  | ||
|
|
||
| - #### common.py | ||
|  | ||
|
|
||
| - #### mentoship_relation.py | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
| You can get a closer look by viewing the file [here](https://drive.google.com/file/d/11gLOJdIu8bRC3OJ0o6K9MqUVeaR_j2ij/view?usp=sharing). | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These images can be stored on the repository itself, we can never be sure what are the longevity of these URLs that are taken from inline comments.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, for your suggestion, @SanketDG. Storing the images in the repository is no question the most ideal way. The thing is for normal contributors like us who're not maintainers of the repository, we don't have access and can't upload files as we like. So, @isabelcosta and I viewed this method (uploading to PR comment and refer it in doc) as the next best thing as alternative. Hope this makes sense 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mtreacy002 Apologies, I do not seem to understand. You can always put the images in the working directory of the git repository and then just git push them so that they appear here, and then they can be referenced from the README files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, @SanketDG if I confused you. @isabelcosta and I discussed this matter (the best way to put image on repository/.md files) here. Instead of uploading the files as binary files we decided the better way is to use reference link from images uploaded to comments like these ones here. Please let me know if this clear up your doubt. Or perhaps you have a better suggestion, we'd like to hear about it. 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, gotcha! I can see how this is beneficial (lesser repository size, smaller clone times) but Git can handle binary files pretty well but it also has a tradeoff, (offline READMEs not a possibility) But yeah, if the image sizes are a problem, then it's better not to add them to the repository.