[jira] [Commented] (JDO-779) Migrate JDO Homepage / Online Documentation

["Craig L Russell (JIRA)" <ji...@apache.org>]

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

Craig L Russell commented on JDO-779:
-------------------------------------

We should use self-service to create a new gitbox repository db-jdo-site that is linked to github and contains the "current contents" of the svn repo jdo/site. We then copy some files directly like the README files and use a more current mvn plugin to generate the site from markdown and then use infra tools to publish the site. 

 

> Migrate JDO Homepage / Online Documentation
> -------------------------------------------
>
>                 Key: JDO-779
>                 URL: https://issues.apache.org/jira/browse/JDO-779
>             Project: JDO
>          Issue Type: Improvement
>          Components: site and infrastructure
>            Reporter: Tilmann Zäschke
>            Assignee: Tilmann Zäschke
>            Priority: Major
>
> The homepage and online documentation is currently generated from xdoc (Maven 1 doc format), located in the SVN 'site' repo. Te homepage and documentation should be migrated to a more modern format, such as markdown, and moved to a new repo.
> Initial investigation:
>  * The only xdoc converter I found is [Doxia|http://maven.apache.org/doxia/doxia-tools/doxia-converter/]. I don't really know all the output formats, but one option may by (x)html. This maybe useful because there exist many html to markdown converters.
>  * If we use 'html' as intermediate stage, it probably makes sense to directly migrate the html version of the home page to markdown.
>  * There are many thml to markdown converters, such as [this PHP command line converter|https://github.com/thephpleague/html-to-markdown].
> TODO:
>  # Decide on target repo and create it. Consensus appears to be to set up a separate git repo, such as 'db-jdo-site'. Where do other projectys host their website code?
>  # Decide on conversion path and target format (html -> markdown seems fine)
>  # Migration



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)