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

Have a readme in every component

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Duplicate
    • Trunk
    • None
    • ALL COMPONENTS
    • 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

          is a child of

          Task - A task that needs to be done. OFBIZ-10285 OFBiz Documentation Global Task

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          is duplicated by

          Task - A task that needs to be done. OFBIZ-11619 Move Framework Stack, Base Application Stack and Plugin Stack wiki pages to Wiki Attic

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. OFBIZ-5838 Have a descriptive WEB page per application

          • Major - Major loss of function.
          • Closed

          Activity

            People

              Unassigned Unassigned
              pierresmits Pierre Smits
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: