Whirr
  1. Whirr
  2. WHIRR-320

Convert site documentation to xdoc format

    Details

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

      Description

      The current Confluence markup doesn't support comments (which annoyingly means we can't include a license header), and doesn't seem to have the same level of support as Apt or Xdoc in Doxia. There is a converter tool to convert from Confluence (http://maven.apache.org/doxia/doxia-tools/doxia-converter/usage.html) - and it seems to do a decent job - so this shouldn't be a lot of work.

      1. WHIRR-320.patch
        137 kB
        Andrei Savu
      2. WHIRR-320.patch
        138 kB
        Andrei Savu

        Activity

        Hide
        Andrei Savu added a comment -

        I've just committed this. Thanks Tom for reviewing. I've also removed *.confluence from the rat exclude list as suggested.

        Show
        Andrei Savu added a comment - I've just committed this. Thanks Tom for reviewing. I've also removed *.confluence from the rat exclude list as suggested.
        Hide
        Tom White added a comment -

        +1

        You can also remove the confluence pattern in the RAT excludes.

        Show
        Tom White added a comment - +1 You can also remove the confluence pattern in the RAT excludes.
        Hide
        Andrei Savu added a comment -

        I've finished fixing all the pages and added some small improvements. I believe the patch is ready.

        Show
        Andrei Savu added a comment - I've finished fixing all the pages and added some small improvements. I believe the patch is ready.
        Hide
        Andrei Savu added a comment -

        First iteration on this one. Some pre-formatted sections need more attention.

        Show
        Andrei Savu added a comment - First iteration on this one. Some pre-formatted sections need more attention.

          People

          • Assignee:
            Andrei Savu
            Reporter:
            Tom White
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development