mentorship-backend icon indicating copy to clipboard operation
mentorship-backend copied to clipboard

docs: Add diagrams to Wiki to help visualise Backend system

Open mtreacy002 opened this issue 5 years ago • 10 comments

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

Screen Shot 2020-04-06 at 9 44 55 pm Screen Shot 2020-04-06 at 9 46 04 pm

draw.io file

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

mtreacy002 avatar Apr 06 '20 11:04 mtreacy002

@isabelcosta, here's the editable link for the document. I already have another copy so, feel free to make adjustment if needed. 😉

mtreacy002 avatar Apr 06 '20 12:04 mtreacy002

Or you can also let me know what needs to be changed, and I can make the adjustment from my end. 😉

mtreacy002 avatar Apr 06 '20 12:04 mtreacy002

Wow!! @mtreacy002 that's really amazing and beginner-friendly diagrams and will surely be useful for others. great work 👍

robotjellyzone avatar Apr 11 '20 14:04 robotjellyzone

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. 😉

mtreacy002 avatar Apr 12 '20 03:04 mtreacy002

no hurry... 👌

mtreacy002 avatar Apr 12 '20 03:04 mtreacy002

Maya if u need any help in reviewing or making the diagrams. i will be more than happy to help. @mtreacy002

nandini45 avatar Apr 12 '20 13:04 nandini45

That'll be great, @nandini45. I'd really appreciate it 😉

mtreacy002 avatar Apr 13 '20 00:04 mtreacy002

@mtreacy002 it would be great if someone could review this. As far as I know you can add this to wiki right?

isabelcosta avatar May 03 '20 20:05 isabelcosta

@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?

mtreacy002 avatar May 03 '20 23:05 mtreacy002

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

vj-codes avatar Mar 09 '21 07:03 vj-codes