ofbiz-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Taher Alkhateeb (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OFBIZ-6243) Have a readme in every component
Date Thu, 22 Sep 2016 09:15:20 GMT

    [ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15512707#comment-15512707

Taher Alkhateeb commented on OFBIZ-6243:

The most important and valuable work is the actual documentation of the components. Right
now what we have is just a skeleton of README files that point to empty wiki pages, there
is no value in that and these wiki pages could be ignored for years. So all this work end
up being confusing

First we must construct good documentation and agree on its contents through proper discussion,
then we can start to wire things together. What we have right now is just noise.

So I also believe a revert is necessary

> 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: Upcoming Branch
> 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

This message was sent by Atlassian JIRA

View raw message