Uploaded image for project: 'Log4j 2'
  1. Log4j 2
  2. LOG4J2-1802

Convert documentation into AsciiDoc

    Details

    • Type: Documentation
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.0.0
    • Component/s: Documentation
    • Labels:
      None

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jvz Matt Sicker
                Reporter:
                jvz Matt Sicker
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: