Jacques Le Roux reassigned OFBIZ-9873:

    Assignee: Taher Alkhateeb  (was: Jacques Le Roux)

> Create a PoC for a documentation system for OFBiz based on Asciidoc
> -------------------------------------------------------------------
>                 Key: OFBIZ-9873
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-9873
>             Project: OFBiz
>          Issue Type: Improvement
>    Affects Versions: Upcoming Branch
>            Reporter: Taher Alkhateeb
>            Assignee: Taher Alkhateeb
>            Priority: Minor
>             Fix For: 17.12.01
>         Attachments: OFBIZ-9873-final.patch, OFBIZ-9873-rouge-coderay.patch, 
> OFBIZ-9873.patch, OFBIZ-9873.patch, OFBIZ-9873.patch
> In reference to the [discussion 
> thread|https://lists.apache.org/thread.html/8cc03b7b8733512244129ddae9e0cc1fb2a28e3e250aba1c8cf678f8@%3Cdev.ofbiz.apache.org%3E]
>  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.

This message was sent by Atlassian JIRA

Reply via email to