Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-8004

Create a read order for the architecture guide

    XMLWordPrintable

    Details

    • Type: Documentation
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: WT10.0.1, 5.2.0, 5.0.5
    • Component/s: None
    • Labels:
      None
    • Story Points:
      0
    • Sprint:
      Storage - Ra 2021-10-04, Storage - Ra 2021-10-18, Storage - Ra 2021-11-01

      Description

      As the Architecture guide is completed it would be beneficial to create a read order page so new hires, and interested users could be guided through it.

      I discussed with Donald Anderson and the general idea we have is:

      1. Create a brief intro to the architecture guide and leave it above the diagram on the main page, in this introduction link to the architecture guide read order page.
      2. Additionally a link to the read order should be added to the new hire wiki page.
      3. Craft an understandable read order page.

      The read order page would have something similar to:

      1. Introduction to WT concepts which also links to the api introduction page and glossary.
      2. A defined order of reading split into digestible chunks, can link to subheadings on pages which have an excess of detail for new readers

      We came up with the following read order which doesn't yet contain all pages:

      Introduction to WiredTiger:
      - Connection 
      - Session
      - Cursor
      - Schema
      - Metadata -> Metadata Table 
      - Transaction
       
      WiredTiger concepts:
      - Snapshot
      - Btree 
      - Cache
      - Eviction
      - Checkpoint
      - History store
      - Dhandles
      - Row store and column store
       
      Extended reading:
      - Logging 
         - Log file format
      - Block manager
      - Data file format
      

      The scope of this ticket is to:

      • Define a read order, validate by reading in said order and having other team members agree on the ordering
        • If gaps are found in the architecture guide create a WT ticket to track the gaps so they can be filled.
        • Possibly organize a meeting to discuss / come up with the read order.
      • Write an introduction in the main page.
      • Write a read order page, similar to what is described above.
        • Link to the page in the wiki.

       

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              tammy.bailey Tammy Bailey
              Reporter:
              luke.pearson Luke Pearson
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: