[SERVER-62087] Architecture Guide updates for PM-2656 Created: 16/Dec/21  Updated: 06/Dec/22  Resolved: 13/Oct/22

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Joe Kanaan Assignee: Backlog - Query Optimization
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Assigned Teams:
Query Optimization
Participants:

 Description   

Please investigate if this project requires changes to the architecture guide.



 Comments   
Comment by Timour Katchaounov [ 13/Oct/22 ]

See discussion above.

Comment by Joe Kanaan [ 13/Oct/22 ]

Yes exactly, the plan is to hopefully have a CQF arch guide. I also missed mentioning this in my last comment: you can close this ticket as won't do.

Comment by Timour Katchaounov [ 13/Oct/22 ]

joseph.kanaan@mongodb.com thank you for the detailed description. Based on it, I conclude that the arch guide is the same as the design documents we all produce. I suggest to discuss at least at team level the need for these architecture documents. I haven't seen one since I am in Mongo, so instead of pretending we might right one, we should discuss if we plan to write arch docs for the CQF project, and most of all how do these documents differ from the design docuements.

Currently any new hire will be directed to read the design documents.

Comment by Joe Kanaan [ 13/Oct/22 ]

Hey timour.katchaounov@mongodb.com, the arch guide provides a comprehensive overview of the project's internals and code that should be useful for any database engineer wanting to understand how the this project works. The goal of this guide is to help both MongoDB engineers quickly understand the workings of this project.

Ideally, every project that introduces a new module, or new component needs to be documented via the arch guide, but realistically that is not happening right now.

The easiest way for me to think about arch guides is this way: If I am a brand new hire to Mongodb and I want to learn about the system architecture and design, what documentation can I read to understand how the system is built, what components connect together, how data flows from A to Z.
The arch guide for projects is exactly the same, but the scope is reduced to just this project and maybe the immediate upstream/downstream producer/consumer.

Comment by Timour Katchaounov [ 13/Oct/22 ]

joseph.kanaan@mongodb.com could you elaborate what is this "architecture guide". I believe no updates are necessary to any documents besides the CE design and scope documents. If we agree on that, perhaps you can close this task as "won't do".

Generated at Thu Feb 08 05:54:08 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.