mentorship-backend
mentorship-backend copied to clipboard
docs: Add diagrams to Wiki to help visualise Backend system
Description
As a new contributor of the open source project, I need to be able to see a visual overview of the existing system that I am going to work on, so that I can quickly gain an understanding of the system current state.
Mocks
Acceptance Criteria
Update [Required]
- [ ] a diagram with relations between classes, entities, different layers of the application.
- [ ] simplified class diagram showing attributes, methods and/or specific information.
- [ ] Wiki documentation to include the above diagrams
Definition of Done
- [ ] All of the required items are completed.
- [ ] Approval by 1 mentor.
Estimation
1 hr
@isabelcosta, here's the editable link for the document. I already have another copy so, feel free to make adjustment if needed. 😉
Or you can also let me know what needs to be changed, and I can make the adjustment from my end. 😉
Wow!! @mtreacy002 that's really amazing and beginner-friendly diagrams and will surely be useful for others. great work 👍
Thanks, for your compliment @robotjellyzone. @isabelcosta, let me know if you approve the issue so I can start working on it and send a PR. 😉
no hurry... 👌
Maya if u need any help in reviewing or making the diagrams. i will be more than happy to help. @mtreacy002
That'll be great, @nandini45. I'd really appreciate it 😉
@mtreacy002 it would be great if someone could review this. As far as I know you can add this to wiki right?
@isabelcosta. Yes, we can add this to wiki, but I have no access to anitab-org wiki so can't create a page for this. Should I just add it to docs folder as .md file for maintainers to upload to wiki?
Making it available as the discussion in PR linked shows very in-depth diagrams and not sure if they can be placed in wiki Maybe different contributors can add simple ones