Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.3-incubating
    • Component/s: None
    • Labels:
      None

      Description

      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.

        Activity

        Shane Bryzak created issue -
        Gerhard Petracek made changes -
        Field Original Value New Value
        Status Open [ 1 ] In Progress [ 3 ]
        Gerhard Petracek made changes -
        Assignee Gerhard Petracek [ gpetracek ] Jason Porter [ lightguard ]
        Hide
        Jason Porter added a comment -

        We're looking at Sphinx: http://sphinx.pocoo.org/. It's the standard in the Python community. John is taking a look at it as well.

        Show
        Jason Porter added a comment - We're looking at Sphinx: http://sphinx.pocoo.org/ . It's the standard in the Python community. John is taking a look at it as well.
        Hide
        Jason Porter added a comment -

        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.

        Show
        Jason Porter added a comment - 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.
        Gerhard Petracek made changes -
        Fix Version/s 0.4-incubating [ 12319863 ]
        Hide
        Gerhard Petracek added a comment -

        apache cms is used currently

        Show
        Gerhard Petracek added a comment - apache cms is used currently
        Gerhard Petracek made changes -
        Status In Progress [ 3 ] Resolved [ 5 ]
        Fix Version/s 0.3-incubating [ 12319478 ]
        Fix Version/s 0.4-incubating [ 12319863 ]
        Resolution Fixed [ 1 ]
        Mark Struberg made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open In Progress In Progress
        5d 15h 28m 1 Gerhard Petracek 21/Dec/11 14:06
        In Progress In Progress Resolved Resolved
        207d 3h 21m 1 Gerhard Petracek 15/Jul/12 18:28
        Resolved Resolved Closed Closed
        40d 1h 26m 1 Mark Struberg 24/Aug/12 19:54

          People

          • Assignee:
            Jason Porter
            Reporter:
            Shane Bryzak
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development