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

Review the WiredTiger GitHub wiki and remove obsolete content

    • Type: Icon: Documentation Documentation
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: WT Docs
    • Storage Engines
    • 5
    • StorEng - Defined Pipeline, StorEng - 2024-01-23, 2024-02-06 tapioooooooooooooca

      Some content on the WiredTiger GitHub wiki is obsolete and should be removed.

      The scope of this ticket is to review the content, identify what is obsolete, and remove it. Bonus points if remaining content can be made more obvious/accessible.

      A first pass assessment:

      Contributing guide - is relevant.

      Benchmarks - are old but also aren't harmful. The haven't been replaced by anything else. I think they should be updated with text to the effect of "The benchmark results reported here were generated before 2014 with a correspondingly old version of WiredTiger. Their content should be considered as a guideline to the current performance of WiredTiger."

      Application developer resources - should be removed. It references an internal MongoDB tool, so shouldn't be on a publicly facing page. The content is potentially interesting - but it appears to be mostly superseded by the (internal) README for the tool.

      HOWTOs:

      • Build A Release - still valid.
      • Run the test suite - dead link. Should be updated.
      • Run Java Tests - should be removed.
      • Build LevelDB - should be removed.
      • Upload a release - should be updated to be current.

      WiredTiger developer resources:
      Should be reviewed and compared to the WiredTiger architecture guide. Any additional information/context should be either ported directly to the architecture guide or be flagged for migration in a future ticket.
      Redundant content should be removed.

            Assignee:
            backlog-server-storage-engines [DO NOT USE] Backlog - Storage Engines Team
            Reporter:
            alexander.gorrod@mongodb.com Alexander Gorrod
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated: