[SERVER-68906] Add Clarity to Storage Execution Docs Created: 17/Aug/22 Updated: 05/Dec/22 |
|
| Status: | Backlog |
| Project: | Core Server |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Matt Kneiser | Assignee: | Backlog - Storage Execution Team |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | documentation | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Assigned Teams: |
Storage Execution
|
| Participants: |
| Description |
|
Two main documents that need some love: The Storage Engine API needs to be more self-contained by defining concepts and explaining context a bit more. Diagrams are also necessary when discussing nested structures and relationships.
The Execution Internals often describes the How but not nearly enough of the What and Why. |
| Comments |
| Comment by Dianna Hohensee (Inactive) [ 23/Aug/22 ] |
|
Come up with a list of questions to file more tickets with specific requests |