ofbiz-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Brohl (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (OFBIZ-6243) Have a readme in every component
Date Fri, 16 Mar 2018 21:45:00 GMT

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

Michael Brohl updated OFBIZ-6243:
---------------------------------
    Description: 
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

  was: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


> 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
>            Assignee: Jacques Le Roux
>            Priority: Minor
>             Fix For: 17.12.01
>
>
> 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
(v7.6.3#76005)

Mime
View raw message