[jira] [Closed] (OFBIZ-6243) Have a readme in every component

Posted by Nicolas Malin (Jira) on Aug 29, 2020; 11:46am
URL: http://ofbiz.116.s1.nabble.com/jira-Closed-OFBIZ-6243-Have-a-readme-in-every-component-tp4758751.html


     [ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jacques Le Roux closed OFBIZ-6243.
----------------------------------
    Resolution: Duplicate

Closing: this is deprecaed now and will be replaced by AsciiDoc files as suggested Michael at https://s.apache.org/6jpdy

> Have a readme in every component
> --------------------------------
>
>                 Key: OFBIZ-6243
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-6243
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: Trunk
>            Reporter: Pierre Smits
>            Priority: Minor
>
> A readme should be the first starting point of each component for developers have references to the placeholder in the wiki, in jira and in svn/viewvc.
> (!) In the course of the asciidoc documentation effort, the existing README.md files should be reworked:
>  * (re-)moved to src/docs/asciidoc/[componentname].adoc
>  * move contents from the wiki to the [componentname].adoc or includes

--
This message was sent by Atlassian Jira
(v8.3.4#803005)