Details

    • Type: Technical task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.6.1, 1.8.0
    • Component/s: segment-tar
    • Labels:

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                frm Francesco Mari
                Reporter:
                mduerig Michael Dürig
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: