Uploaded image for project: 'OFBiz'
  1. OFBiz
  2. OFBIZ-9873

Create a PoC for a documentation system for OFBiz based on Asciidoc

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: Upcoming Branch
    • Fix Version/s: Upcoming Branch
    • Component/s: None
    • Labels:
      None

      Description

      In reference to the discussion thread this is an attempt to create a PoC for OFBiz documentation system based on Asciidoc. The main assumptions for the design of this system are:

      • The documentation language to use is Asciidoc
      • The documentation tool is Asciidoctor
      • Publishing happens through Gradle using the asciidoctor gradle plugin (not the OFBiz framework or anything else).
      • The only place where we write documentation is inside the code base
      • Every component contains its own documentation
      • General documentation goes to either a standalone directory or a generic component like common or base
      • As much as possible, documentation files are small and focused on one topic. And then other longer documents are constructed from these snippets of documentation.
      • We publish to all formats including PDF for users, or HTML for embedded help and wiki pages. So OFBiz does not parse docbook for its help system, instead it just renders generated HTML.

        Attachments

        1. OFBIZ-9873.patch
          0.9 kB
          Taher Alkhateeb
        2. OFBIZ-9873.patch
          5 kB
          Taher Alkhateeb
        3. OFBIZ-9873.patch
          1 kB
          Taher Alkhateeb
        4. OFBIZ-9873-rouge-coderay.patch
          3 kB
          Jacques Le Roux

          Issue Links

            Activity

              People

              • Assignee:
                taher Taher Alkhateeb
                Reporter:
                taher Taher Alkhateeb
              • Votes:
                1 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: