[SERVER-74081] Execution Architecture Guide is lengthy Created: 16/Feb/23 Updated: 23/Feb/23 |
|
| Status: | Backlog |
| Project: | Core Server |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Haley Connelly | Assignee: | Backlog - Storage Execution Team |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Assigned Teams: |
Storage Execution
|
| Participants: |
| Description |
|
Right now, the architecture guide in catalog/README.md covers topics spanning several directories While it's nice to have information in a single location, it can be overwhelming for readers. We should consider splitting the Architecture Guide into corresponding sub-directories. For Example: It could be useful to split up Concurreny Control topics into its own README under the concurrency/. |
| Comments |
| Comment by Fausto Leyva (Inactive) [ 23/Feb/23 ] |
|
Yeah, that would make traversing through the guide a bit easier. Github also allows for collapsable sections: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections
|
| Comment by Haley Connelly [ 23/Feb/23 ] |
|
I agree with louis.williams@mongodb.com in that a table of contents would be a feasible start |
| Comment by Fausto Leyva (Inactive) [ 21/Feb/23 ] |
|
Propose more actionable updates to the arch guide. |
| Comment by Louis Williams [ 16/Feb/23 ] |
|
From past discussions with the team, we seemed to be in agreement that having one large readme is preferable because it's easier to search. But maybe we can do some work to create a table of contents. |
| Comment by Haley Connelly [ 16/Feb/23 ] |
|
Credit to fausto.leyva@mongodb.com for making this suggestion while reviewing the Architecture Guide additions in |