Uploaded image for project: 'OFBiz'
  1. OFBiz
  2. OFBIZ-6243

Have a readme in every component

    Details

    • Type: Improvement
    • Status: Reopened
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: Trunk
    • Fix Version/s: 17.12.01
    • Component/s: ALL COMPONENTS
    • Labels:
      None

      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

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jacques.le.roux Jacques Le Roux
                Reporter:
                pfm.smits Pierre Smits
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated: