You are viewing a plain text version of this content. The canonical link for it is here.

Posted to oak-issues@jackrabbit.apache.org by "Michael Dürig (JIRA)" <ji...@apache.org> on 2013/07/24 11:09:48 UTC

[jira] [Commented] (OAK-301) Document Oak

    [ https://issues.apache.org/jira/browse/OAK-301?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13718151#comment-13718151 ] 

Michael Dürig commented on OAK-301:
-----------------------------------

I broadened this issue to not only include internal documentation. I think we should put all kind of Oak documentation into the {{doc}} module to keep it as close to the source code as possible. This will later on allow us to automatically build and distribute documentation artefacts and maybe even update a documentation web site. 
                
> Document Oak
> ------------
>
>                 Key: OAK-301
>                 URL: https://issues.apache.org/jira/browse/OAK-301
>             Project: Jackrabbit Oak
>          Issue Type: Task
>          Components: doc
>            Reporter: Jukka Zitting
>
> To make it easier for new people to get involved, we should have some higher level documentation than just javadocs and dev@ threads about key parts of the internal design in Oak.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira