[OFBIZ-12035] asciidoc Image directory convention for plugins and components

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: Trunk
• Fix Version/s: Trunk
• Component/s: birt
• Labels: Documentation
• Assignee: Olivier Heintz
• Reporter: Olivier Heintz
• Created: 01/Oct/20 13:23
• Updated: 06/Oct/20 10:24
• Resolved: 05/Oct/20 12:28

Description

Plugins documentation (in asciidoc) can be generated with one document per plugins (in https://ci.apache.org/projects/ofbiz/site/trunk/pluginsdoc/ directory) or include in the general user-manual or developer-manual

Currently, image usage not works in the two case, because image path is relative to the root document.

To solve the problem, I propose to put image(s) relative to a component in the src/docs/asciidoc/images/${component.name} of the component and modifying gradle generateDocumentation task to copy the subdirectory in the general docs/asciidoc/images/ directory before generation and remove it after.

Currently only birt is concern but it's better to have schema and other image in documentation, so in future all components should be concerned.