[OAK-5547] Document TarMK design

• Type: Technical task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.6.1, 1.8.0
• Component/s: segment-tar
• Labels: documentation
• Assignee: Francesco Mari
• Reporter: Michael Dürig
• Created: 30/Jan/17 16:13
• Updated: 04/Oct/19 17:52
• Resolved: 01/Feb/17 14:39

Description

We should improve our documentation of the internal design of the the TarMK. There is currently a single section.

• Add a high level class diagram and description of the overall structure of the TarMK.
• Decide what to do with segmentmk.md. My preference would be to incorporate everything from it we didn't cover so far into segment/overview.md, segment/records.md and segment/tar.md.
• Rewrite, clarify the design section in segment/overview.md.

Issue Links

• is related to: OAK-5976 Document enhancements in 1.6 release