[LOG4J2-1802] Convert documentation into AsciiDoc

• Type: Documentation
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.0
• Component/s: Documentation
• Assignee: Matt Sicker
• Reporter: Matt Sicker
• Created: 29/Jan/17 18:09
• Updated: 09/Apr/18 02:16
• Resolved: 09/Apr/18 02:16

Description

The xdoc system currently in place is difficult to use correctly (it expects proper XHTML, no block level elements inside inline level elements, the usual pedantry from an XHTML/XML validator) and is needlessly verbose for writing documentation.

After experimenting with Markdown as an alternative to xdoc, it has not been powerful enough for our uses. AsciiDoc, however, does offer more features useful here without extending the markdown processor itself. This will also help unify documentation formats used in other Log4j projects.

Issue Links

• links to: asciidoctor-maven-plugin
• links to: pandoc