[jira] [Comment Edited] (OAK-301) Document Oak

["Michael Dürig (JIRA)" <ji...@apache.org>]

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

Michael Dürig edited comment on OAK-301 at 8/1/13 7:05 PM:
-----------------------------------------------------------

At revision 1509212 I added the option to directly deploy the documentation to our website. Furthermore I included and linked aggregated Javadocs. 

Use

{code}
mvn site
{code}

to build the site. Review the site at {{oak-doc/target/site}}.

Then deploy the site to http://jackrabbit.apache.org/oak/docs/ using

{code}
mvn site-deploy
{code}

Finally review the site at http://jackrabbit.apache.org/oak/docs/index.html.

Every committer should be able to deploy the site. No fiddling with credentials needed since deployment is done through {{svn commit}} to https://svn.apache.org/repos/asf/jackrabbit/site/live/oak/docs
                
      was (Author: mduerig):
    At revision 1509212 I added the option to directly deploy the documentation to our website. Furthermore I included and linked aggregated Javadocs. 

Use

{code}
mvn site:site
{code}

to build the site. Review the site at {{oak-doc/target/site}}.

Then deploy the site to http://jackrabbit.apache.org/oak/docs/ using

{code}
mvn site-deploy
{code}

Finally review the site at http://jackrabbit.apache.org/oak/docs/index.html.

Every committer should be able to deploy the site. No fiddling with credentials needed since deployment is done through {{svn commit}} to https://svn.apache.org/repos/asf/jackrabbit/site/live/oak/docs
                  
> 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