[OFBIZ-6243] Have a readme in every component

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Duplicate
• Affects Version/s: Trunk
• Component/s: ALL COMPONENTS
• Assignee: Unassigned
• Reporter: Pierre Smits
• Created: 11/Apr/15 12:30
• Updated: 29/Aug/20 11:53
• Resolved: 29/Aug/20 11:45

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

Issue Links

• is a child of: OFBIZ-10285 OFBiz Documentation Global Task
• is duplicated by: OFBIZ-11619 Move Framework Stack, Base Application Stack and Plugin Stack wiki pages to Wiki Attic
• is related to: OFBIZ-5838 Have a descriptive WEB page per application

Sub-Tasks

• Incorporate the readme for the webPOS component: Open
• Incorporate the readme for the WebTools component: Open
• Incorporate the readme for the HumanRes component: Open
• Incorporate the readme for the Marketing component: Open
• Incorporate the readme for the Party component: Open
• Incorporate the readme for the SecurityExt component: Open
• Incorporate the readme for the WorkEffort component: Open