You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by "Matt Sicker (JIRA)" <ji...@apache.org> on 2018/04/09 02:17:00 UTC

[jira] [Resolved] (LOG4J2-1802) Convert documentation into AsciiDoc

     [ https://issues.apache.org/jira/browse/LOG4J2-1802?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Matt Sicker resolved LOG4J2-1802.
---------------------------------
       Resolution: Fixed
    Fix Version/s: 3.0.0

All pages other than the maven dependencies one as noted has been converted.

> Convert documentation into AsciiDoc
> -----------------------------------
>
>                 Key: LOG4J2-1802
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-1802
>             Project: Log4j 2
>          Issue Type: Documentation
>          Components: Documentation
>            Reporter: Matt Sicker
>            Assignee: Matt Sicker
>            Priority: Major
>             Fix For: 3.0.0
>
>
> 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.



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