Initial Design document finalize

[tekrajchhetri]

This PR adds the following:

1. Initial design document providing overview of BrainyPedia
2. Principles of BrainyPedia
3. Initial microservices based architecture.
4. Other considerations that BrainyPedia makes
5. Sequence diagram demonstrating steps and the interactions amongst different components for manual KG construction.

@satra

[satra]

@tekrajchhetri - take a look at the embargo and other design docs in dandi-archive and update this to reflect that. break the document into:

• use-cases (this should include)
• target audience groups
• architecture details (specific approaches and components)
• implementation plan

for the sequence diagram, insert the mermaid code directly in the markdown.

please work directly with @puja-trivedi on the design and ping @djarecka for reviews.

[djarecka]

@tekrajchhetri - I've left bunch of comments/questions. Basically, I asked all the questions I had when reading since many points were very general. However, I'm not sure if you are ready to answer all the questions. If something will have to be specified later (e.g. after seeing data, or talking to other people), perhaps it should be clarified?

fyi. i have not checked the architecture

[tekrajchhetri]

Hi @tekrajchhetri thanks for your patience. In general I love the vision you've laid out in the doc, and the doc lays out a compelling high level technical approach (principles & architecture).

As a technical design doc, I feel like there's a lot of detail missing. I would expect data models, API models, deployment & testing approaches, etc. If that doesn't jive with your approach - e.g. you're just planning to start working on the high level aims in this doc and get feedback as you go - that can work too; in that case I would strongly suggest you add a "workplan" section and list out - in priority order - what features you plan to add, so others & I can give feedback on that prioritization.

I'd also suggest you add a section about hosting infrastructure: the beta site is very slow right now (totally fine!) so I'm sure you have thoughts on how to improve the performance, stability, IaC, etc., and it's worth spelling that out a bit. If you don't think you'll be able to harden the tool in those ways, that's OK too, but that would be good context to document so others & I can consider how this tool fits into the overall project most effectively.

Best, Tyler

Thanks @tylenolncuff, I will update the design document accordingly.

[candleindark]

I think the phrase "content moderation of the content" can be just "content moderation".

[tekrajchhetri]

I think the phrase "content moderation of the content" can be just "content moderation".

Thank you for catching it, I will update the document

[candleindark]

I think the boxed section is a redundant since providing a platform is a way of facilitating.

(Sorry for the spams. I don't have the application to edit the vsdx file).

[tekrajchhetri]

I think the boxed section is a redundant since providing a platform is a way of facilitating.

(Sorry for the spams. I don't have the application to edit the vsdx file).

@candleindark You would need to edit using the Microsoft Visio. If you have access to Office 365 then you should have also access to the visio. I have shared the link with you via slack.

[tekrajchhetri]

I think the boxed section is a redundant since providing a platform is a way of facilitating.
(Sorry for the spams. I don't have the application to edit the vsdx file).

@candleindark You would need to edit using the Microsoft Visio. If you have access to Office 365 then you should have also access to the visio. I have shared the link with you via slack.

I have updated the image now as per your comment

[candleindark]

I think the boxed section is a redundant since providing a platform is a way of facilitating.
(Sorry for the spams. I don't have the application to edit the vsdx file).

@candleindark You would need to edit using the Microsoft Visio. If you have access to Office 365 then you should have also access to the visio. I have shared the link with you via slack.

Great. After some poking around, I found out my access for Office365 through Dartmouth. Thanks.