[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186952#comment-17186952 ] ASF subversion and git services commented on OFBIZ-6243: Commit b9a3be3e1eb6b95e425f030d20507214ec512a1a in ofbiz-plugins's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-plugins.git;h=b9a3be3 ] Reverted: "Improved: Have a readme in every component (OFBIZ-6243)" This reverts commit 598cf6c27df6b41ff8be6d45c2c0eedc80300280. An Apache URL is much easier to have (NO bad idea, does not show like the camo.githubusercontent.com link does, cache control issue on ASF servers?) > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186951#comment-17186951 ] ASF subversion and git services commented on OFBIZ-6243: Commit c8c58957073ea2583ab7a1bef54dc5521deb7e79 in ofbiz-framework's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=c8c5895 ] Reverted: "Improved: Have a readme in every component (OFBIZ-6243)" This reverts commit f281fe290ab98b38122525e3aff40643bb61dadd. An Apache URL is much easier to have (NO bad idea) > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186949#comment-17186949 ] ASF subversion and git services commented on OFBIZ-6243: Commit f281fe290ab98b38122525e3aff40643bb61dadd in ofbiz-framework's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=f281fe2 ] Improved: Have a readme in every component (OFBIZ-6243) An Apache URL is much easier to have > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186947#comment-17186947 ] ASF subversion and git services commented on OFBIZ-6243: Commit 598cf6c27df6b41ff8be6d45c2c0eedc80300280 in ofbiz-plugins's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-plugins.git;h=598cf6c ] Improved: Have a readme in every component (OFBIZ-6243) An Apache URL is much easier to have > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186944#comment-17186944 ] ASF subversion and git services commented on OFBIZ-6243: Commit 081a204ee301eee525dd57b2ddf5fc64b973b355 in ofbiz-framework's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=081a204 ] Improved: Have a readme in every component (OFBIZ-6243) Not sure why we have this problem (according to https://docs.github.com/en/github/authenticating-to-github/about-anonymized-image-urls could be to missing cache control in our site server) As I was fed up not viewing the OFBIz logo anywhere, and mostly in GH, but just in browser at https://ofbiz.apache.org/images/ofbiz_logo.png and I noticed I was viewing it well locally at https://github.com/apache/ofbiz-framework/tree/trunk/themes/rainbowstone so decided to use this URL everywhere rather! > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186943#comment-17186943 ] ASF subversion and git services commented on OFBIZ-6243: Commit 9bf5e044f77e576f0c8ae210e63401c6b60e6faa in ofbiz-plugins's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-plugins.git;h=9bf5e04 ] Improved: Have a readme in every component (OFBIZ-6243) Not sure why we have this problem (according to https://docs.github.com/en/github/authenticating-to-github/about-anonymized-image-urls could be to missing cache control in our site server) As I was fed up not viewing the OFBIz logo anywhere, and mostly in GH, but just in browser at https://ofbiz.apache.org/images/ofbiz_logo.png and I noticed I was viewing it well locally at https://github.com/apache/ofbiz-framework/tree/trunk/themes/rainbowstone so decided to use this URL everywhere rather! > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186942#comment-17186942 ] ASF subversion and git services commented on OFBIZ-6243: Commit ee0968440ef0b664eddb5840ef5c8abd261fb23b in ofbiz-framework's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=ee09684 ] Improved: Have a readme in every component (OFBIZ-6243) Not sure why we have this problem (according to https://docs.github.com/en/github/authenticating-to-github/about-anonymized-image-urls could be to missing cache control in our site server) As I was fed up not viewing the OFBIz logo anywhere, and mostly in GH, but just in browser at https://ofbiz.apache.org/images/ofbiz_logo.png and I noticed I was viewing it well locally at https://github.com/apache/ofbiz-framework/tree/trunk/themes/rainbowstone so decided to use this URL everywhere rather! > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186927#comment-17186927 ] ASF subversion and git services commented on OFBIZ-6243: Commit d15cc57bf0d01c7b540d0ab9082743d3c29447d9 in ofbiz-framework's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=d15cc57 ] Improved: Have a readme in every component (OFBIZ-6243) This preludes the move of content of README.md files into the asciidoc documentation Updates the link to OFBiz-logo.png Removes deprecated information related to Svn, Jira and Confluence We will move the wiki pages to wiki attic with OFBIZ-11619 > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17186925#comment-17186925 ] ASF subversion and git services commented on OFBIZ-6243: Commit 7d140f3e278d8e34d2bdc030fff14abcb2684222 in ofbiz-plugins's branch refs/heads/trunk from Jacques Le Roux [ https://gitbox.apache.org/repos/asf?p=ofbiz-plugins.git;h=7d140f3 ] Improved: Have a readme in every component (OFBIZ-6243) This preludes the move of content of README.md files into the asciidoc documentation Updates the link to OFBiz-logo.png (also in ReportDesignGenerator.java) Removes deprecated information related to Svn, Jira and Confluence We will move the wiki pages to wiki attic with OFBIZ-11619 > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16402624#comment-16402624 ] Jacques Le Roux commented on OFBIZ-6243: +1, only the content is important > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16402599#comment-16402599 ] Taher Alkhateeb commented on OFBIZ-6243: Agreed. No reason to keep README files. > 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)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16402592#comment-16402592 ] Michael Brohl commented on OFBIZ-6243: -- 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 > 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 -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16401659#comment-16401659 ] Sharan Foga commented on OFBIZ-6243: Link to Global Documentation Task > 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 -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15512850#comment-15512850 ] Pierre Smits commented on OFBIZ-6243: - Of course I intend to do anything to have my itch scratched. :) > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15512767#comment-15512767 ] Jacques Le Roux commented on OFBIZ-6243: You need to start and this is a good start to me. As long as it is maintained and hopefully improved by the community as a whole I see no reasons to revert. Of course if you have something better to commit in its stead I'll consider it. > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15512680#comment-15512680 ] Jacopo Cappellato commented on OFBIZ-6243: -- It is concerning that, rather than listening to another committer's constructive review, Jacques decided to ignore and do the commit. Vetoing a commit is always an unpleasant event that happened very few times in the history of OFBiz and I hope we will not have to go into this direction this time. > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15512598#comment-15512598 ] Michael Brohl commented on OFBIZ-6243: -- I cannot prevent you from committing but I clearly object against it. > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15512524#comment-15512524 ] Michael Brohl commented on OFBIZ-6243: -- I haven't wrote that there are readme's without a Wiki pages. I wrote that they should have proper content and not just a few sentences which don't add much value. Please see my other comments. > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[
https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15512437#comment-15512437
]
Pierre Smits commented on OFBIZ-6243:
-
To see the effect of a readme per component, see the following:
{code}https://github.com/ofbizci/manufacturing{code}
vs
{code}https://github.com/ofbizci/order{code}
> 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
(v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15445603#comment-15445603 ] Jacques Le Roux commented on OFBIZ-6243: I had a look into 3 other major TLPs * Ant: no ASL2 in readme files * JMeter: no ASL2 in readme files * Tomcat: no ASL2 in readme files Before Pierre's effort we had also no ASL2 in readme files Incubating Freemarker has ASL2 in readme files At least we should be consistent and have them or not. I suggest the single line solution. > 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 > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15445279#comment-15445279 ] Jacques Le Roux commented on OFBIZ-6243: And another interesting discussion here also https://github.com/apache/incubator-ponymail/pull/56 I see people already asked to not too much break up contributions and that they don't agree with you about your viewpoint on ASL2 everywhere(with examples and arguments) > 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 > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15445232#comment-15445232 ] Pierre Smits commented on OFBIZ-6243: - The short form can be applied to any piece of work? If so, every piece of work could have the short form, not only scripts. Wouldn't more variants applied lead to more false positives in the license checker of the ASF? You are right. The complete ASL2 is more. See http://www.apache.org/licenses/LICENSE-2.0. That is why we (and I guess all of the projects under the umbrella of the ASF) don't include that verbatim in each file, but the shortened variant (16 lines of text). But, that is applicable to software code. Where we want to enable 3rd parties to alter the code to meet their requirements, without having the need to bring their changes back to the project. Do we want that too for documentation? > 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 > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15444243#comment-15444243 ] Taher Alkhateeb commented on OFBIZ-6243: okay thank you for the feedback. I don't see much added value in these files honestly (just a link with a sentence that you can easily lookup elsewhere) but If you want to continue the work then go ahead. I would recommend removing the sub JIRA mess and continue in this JIRA. That would actually be faster and the whole thing should take very little time anyway based on the very brief contents of these files. > 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 > 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 (v6.3.4#6332)
[jira] [Commented] (OFBIZ-6243) Have a readme in every component
[ https://issues.apache.org/jira/browse/OFBIZ-6243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15444208#comment-15444208 ] Jacques Le Roux commented on OFBIZ-6243: And that https://mrhaki.blogspot.fr/2014/04/awesome-asciidoc-include-partial-parts.html :) > 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 > 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 (v6.3.4#6332)
