[JDO-779] Migrate JDO Homepage / Online Documentation

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: JDO 3.2
• Component/s: site and infrastructure
• Assignee: Tilmann Zäschke
• Reporter: Tilmann Zäschke
• Created: 23/Mar/19 16:18
• Updated: 17/Feb/22 19:54
• Resolved: 30/Jul/20 18:16

Description

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. 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.

TODO:

1. 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?
2. Decide on conversion path and target format (html -> markdown seems fine)
3. Migration

Issue Links

• is related to: JDO-770 Switch from svn to git
• links to: GitHub Pull Request #2
• links to: GitHub Pull Request #3
• links to: GitHub Pull Request #4