apache / apache/maven-parent

Proposal: Don't relativize site links

Open Beginner friendly
#559 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
No language data
Stars
36
Forks
30
Avg merge
1d 7h
Merged PRs (30d)
7

Description

### New feature, improvement proposal

Currently the [m-site-p parameter `relativizeSiteLinks`](https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#relativizesitelinks) is not set, i.e. image urls like https://github.com/apache/maven-parent/blob/113f357ac5dcd914f4267841a1353fe5a066e64f/src/site/site.xml#L26 are relativized as `../../images/apache-maven-project-light-theme.svg` which only works once deployed on the ASF webserver, but not for local previews.

Although this impacts all generated sites, I would argue that the additional few bytes for the absolute URL doesn't matter.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the m-site-p `relativizeSiteLinks` parameter and the example configuration in src/site/site.xml. Check how generated image links behave in a local preview, then adjust the relevant setting so those links remain absolute; verify that local previews work without breaking deployed site links.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.