Skip to content

Fix documentation issues in site pages#417

Merged
elharo merged 3 commits into
apache:masterfrom
elharo:fix-docs-issues
Jul 24, 2026
Merged

Fix documentation issues in site pages#417
elharo merged 3 commits into
apache:masterfrom
elharo:fix-docs-issues

Conversation

@elharo

@elharo elharo commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Various documentation fixes:

  • Upgrade plexus-utils link to HTTPS
  • Reword "forked from" → "originated in" (more precise)
  • Clarify ambiguous "the original" phrasing
  • Remove redundant parenthetical "(different)"
  • Use proper project reference "Commons versions"
  • Use project display name "Maven Shared Utils"
  • Upgrade XSD URL from HTTP to HTTPS in site.xml

- Upgrade plexus-utils link to HTTPS
- Reword 'forked from' -> 'originated in'
- Clarify ambiguous 'the original' phrasing
- Remove redundant parenthetical (different)
- Use proper project name 'Commons versions'
- Use project display name 'Maven Shared Utils'
- Upgrade XSD URL from HTTP to HTTPS in site.xml
@elharo
elharo requested a review from Copilot July 23, 2026 15:05
@elharo elharo added the documentation Improvements or additions to documentation label Jul 23, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Maven Shared Utils project site documentation to improve clarity and consistency, and to modernize external references by switching relevant URLs to HTTPS.

Changes:

  • Switch the plexus-utils link in the site index page from HTTP to HTTPS.
  • Reword several sentences in the site index page for clearer, more precise phrasing and naming.
  • Switch the Maven site decoration XSD URL in site.xml from HTTP to HTTPS.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/site/site.xml Updates the decoration XSD schema URL to HTTPS.
src/site/apt/index.apt.vm Updates external link to HTTPS and refines wording/naming in the intro content.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/site/apt/index.apt.vm Outdated
Comment thread src/site/apt/index.apt.vm Outdated
elharo and others added 2 commits July 23, 2026 15:15
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@elharo
elharo requested a review from ascheman July 23, 2026 15:17

@ascheman ascheman left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Elliott — nice cleanup. I checked each change:

  • HTTPS upgrades (plexus-utils link in index.apt.vm, XSD schemaLocation in site.xml) — correct. Good catch leaving the xmlns= decoration namespace on http://; that's an identifier, not a URL, so it must stay as-is.
  • Wording — "originated in" over "forked from", dropping the redundant "(different)", and "Commons versions" all read more precisely.
  • Naming — standardizing the prose on "Maven Shared Utils" (the ${project.name} display form) is the right call; both remaining prose mentions are now consistent.

Copilot's consistency note is already satisfied by the final state of the file — no lowercase maven-shared-utils left in prose. CI is green across all 11 jobs. LGTM. 👍

@elharo
elharo merged commit cc8675b into apache:master Jul 24, 2026
11 checks passed
@elharo
elharo deleted the fix-docs-issues branch July 24, 2026 10:50
@github-actions github-actions Bot added this to the 3.5.0 milestone Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants