[ https://issues.apache.org/jira/browse/OAK-5547?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15848436#comment-15848436 ]
Francesco Mari edited comment on OAK-5547 at 2/1/17 2:38 PM: ------------------------------------------------------------- I updated the section about record numbers and offsets at r1781253. was (Author: frm): I update the section about record numbers and offsets at r1781253. > Document TarMK design > --------------------- > > Key: OAK-5547 > URL: https://issues.apache.org/jira/browse/OAK-5547 > Project: Jackrabbit Oak > Issue Type: Technical task > Components: segment-tar > Reporter: Michael Dürig > Assignee: Francesco Mari > Labels: documentation > Fix For: 1.8, 1.6.1 > > > We should improve our documentation of the internal design of the the TarMK. > There is currently a [single > section|http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#design]. > > * 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}}. -- This message was sent by Atlassian JIRA (v6.3.15#6346)