[jira] [Commented] (DELTASPIKE-13) Choose documentation format and tools

["Jason Porter (Commented) (JIRA)" <ji...@apache.org>]

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

Jason Porter commented on DELTASPIKE-13:
----------------------------------------

Another tool has recently come to my attention: ASCIIDOC (www.methods.co.nz/asciidoc/). It's quite easy to use and understand (www.methods.co.nz/asciidoc/userguide.html). It also has the advantage of outputting docbook, epub, pdf, html, manpages, etc. It's also written in python. Version 8.6.7 works on jython. If we wanted to use it from Maven, we'd need to write a plugin, but so far using it has been very enjoyable and really not that much harder to pickup than markdown. Just another option to consider.
                
> Choose documentation format and tools
> -------------------------------------
>
>                 Key: DELTASPIKE-13
>                 URL: https://issues.apache.org/jira/browse/DELTASPIKE-13
>             Project: DeltaSpike
>          Issue Type: Task
>            Reporter: Shane Bryzak
>            Assignee: Jason Porter
>
> We need to decide on a documentation format for the DeltaSpike documentation.  Requirements are:
> 1. Kept in the VCS with the DeltaSpike codebase
> 2. Buildable with Maven
> 3. Can generate multiple formats, including HTML and PDF
> Currently the "industry standard" is DocBook, however there may be other alternatives which are more suitable.  Suggestions welcome here.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira