[MSITE-535] Do not use project.url for relative link resolution

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.2
• Fix Version/s: 2.3, 3.0
• Component/s: doxia integration, inheritance, relative links
• Assignee: Lukas Theussl
• Reporter: Lukas Theussl
• Created: 19/Dec/10 10:15
• Updated: 20/Dec/15 03:08
• Resolved: 31/Jan/11 04:12

Description

IMO distributionManagement.site.url should be used instead. Imagine a multi-module site with a distributionManagement url that points to the local file system. A local deploy will move any child sites to sub-directories of the parent (by default), but if you forget to adjust the project urls for all children, the relative links are all wrong because they are calculated from the project urls. There are numerous examples and JIRAs where people are confused about this. Having to specify a url for each single child project is a duplicate information and is also logically not necessary. Note that the distributionManagement url always exists (otherwise the deploy will fail), while the project url is optional. IMO the project url should not be used for the local site generation at all, it is just a piece of user information.

Issue Links

• depends upon: MSHARED-180 Do not use project.url for relativ link resolution
• is related to: MSITE-709 relativizeDecorationLinks=false seems to be ignored
• relates to: MSITE-227 site:deploy -> wrong links in ${modules} when artifactId=module's directory
• relates to: MSITE-466 Breadcrumbs to grandparent in flat multi-module project broken
• relates to: MSITE-547 Links to child modules do not work when using flat structure
• relates to: MSITE-509 site-deploy with flat project layout generates wrong url for breadcrumb