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
          1.
          		 Incorporate the readme for the webPOS component Sub-task Open Unassigned
          2.
          		 Incorporate the readme for the POS component Sub-task Closed Jacques Le Roux
          3.
          		 Incorporate the readme for the projectmgr component Sub-task Closed Pierre Smits
          4.
          		 Incorporate the readme for the scrum component Sub-task Closed Pierre Smits
          5.
          		 Incorporate the readme for the Manufacturing component Sub-task Closed Pierre Smits
          6.
          		 Incorporate the readme for the MyPortal component Sub-task Closed Pierre Smits
          7.
          		 Incorporate the readme for the AssetMaint application Sub-task Closed Pierre Smits
          8.
          		 Incorporate the readme for the Lucene component Sub-task Closed Pierre Smits
          9.
          		 Incorporate the readme for the bizznesstime theme Sub-task Closed Pierre Smits
          10.
          		 Incorporate the readme for the SOLR component Sub-task Closed Pierre Smits
          11.
          		 Incorporate the readme for the WebTools component Sub-task Open Unassigned
          12.
          		 Incorporate the readme for the Accounting component Sub-task Closed Pierre Smits
          13.
          		 Incorporate the readme for the commonExt component Sub-task Closed Pierre Smits
          14.
          		 Incorporate the readme for the Content component Sub-task Closed Pierre Smits
          15.
          		 Incorporate the readme for the datamodel component Sub-task Closed Pierre Smits
          16.
          		 Incorporate the readme for the HumanRes component Sub-task Open Unassigned
          17.
          		 Incorporate the readme for the Marketing component Sub-task Open Unassigned
          18.
          		 Incorporate a readme for the Order component Sub-task Closed Pierre Smits
          19.
          		 Incorporate the readme for the Party component Sub-task Open Unassigned
          20.
          		 Incorporate the readme for the Product component Sub-task Closed Pierre Smits
          21.
          		 Incorporate the readme for the SecurityExt component Sub-task Open Unassigned
          22.
          		 Incorporate the readme for the WorkEffort component Sub-task Open Unassigned
          23.
          		 Remove legal statement from existing readme files Sub-task Closed Jacques Le Roux

          Activity

            People

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

              Dates

                Created:
                Updated:
                Resolved: