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

Have a readme in every component

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Duplicate
    • Affects Version/s: Trunk
    • Fix Version/s: None
    • 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

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

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              pierresmits Pierre Smits

              Dates

              • Created:
                Updated:
                Resolved:

                Issue deployment