Skip to content

docs: fix text quality issues in configuring.md and cache-configuration.md - #12638

Merged
elharo merged 6 commits into
masterfrom
pr-5-8
Jul 30, 2026
Merged

docs: fix text quality issues in configuring.md and cache-configuration.md#12638
elharo merged 6 commits into
masterfrom
pr-5-8

Conversation

@elharo

@elharo elharo commented Jul 30, 2026

Copy link
Copy Markdown
Contributor
  • Update phrasing from 'Contrary to... those files' to 'Unlike... these files'
  • Remove possessive from 'Maven's DefaultRequestCache' for consistency
  • Populate empty sections for Settings and Extensions with factual content

…on.md

- Update phrasing from 'Contrary to... those files' to 'Unlike... these files'
- Remove possessive from 'Maven's DefaultRequestCache' for consistency
- Populate empty sections for Settings and Extensions with factual content

@gnodet gnodet 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.

The text quality fixes are good improvements — the phrasing correction ("Unlike standard properties files, these files") and the possessive removal are both clean.

Two documentation accuracy observations on the new Settings and Extensions content:

  1. Property name: ${maven.conf} is not a canonical Maven 4 property. The correct property is ${maven.installation.conf} (defined in Constants.java as MAVEN_INSTALLATION_CONF, default ${maven.home}/conf). The shipped maven-system.properties also uses maven.installation.conf. While maven.conf exists as a legacy fallback for backward compatibility, the Maven 4 documentation should reference the canonical name.

  2. Missing project-level configuration: Maven 4 defines three configuration levels for both settings and extensions — installation, user, and project (${maven.project.conf}/settings.xml.mvn/settings.xml, and ${maven.project.conf}/extensions.xml.mvn/extensions.xml). These are defined in Constants.java (MAVEN_PROJECT_SETTINGS, MAVEN_PROJECT_EXTENSIONS) and configured in the shipped maven-system.properties. The PR currently only documents two of the three levels.

Also, the PR body references "Fixes #5, #6, #7, #8" but those are unrelated, already-closed issues from 2013-2014.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

@elharo
elharo requested a review from Copilot July 30, 2026 17:16
Corrected the reference to the Maven installation configuration path and updated the environment variable terminology.

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

Improves the Maven site documentation wording and fills in previously empty sections related to configuration locations, aiming to make configuration guidance clearer and more consistent across docs.

Changes:

  • Refines wording around Maven properties file encoding and MAVEN_ARGS terminology in configuring.md.
  • Adds introductory content for Settings and Extensions configuration in configuring.md.
  • Adjusts phrasing in cache-configuration.md to remove possessive wording around DefaultRequestCache.

Reviewed changes

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

File Description
src/site/markdown/configuring.md Updates phrasing and adds Settings/Extensions configuration guidance.
src/site/markdown/cache-configuration.md Tweaks introductory sentence wording for cache configuration docs.

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

Comment thread src/site/markdown/configuring.md Outdated
Comment thread src/site/markdown/configuring.md Outdated
Comment thread src/site/markdown/cache-configuration.md Outdated

@gnodet gnodet 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.

The new commit correctly addresses the prior review feedback:

  • ${maven.conf}${maven.installation.conf}, matching Constants.MAVEN_INSTALLATION_CONF
  • "environment value" → "environment variable" — correct terminology
  • "Those" → "These" — appropriate for adjacent context

Nice cleanup. The text quality fixes and property name correction are solid improvements.

Minor suggestion (non-blocking): The Settings and Extensions sections currently document only user and installation levels. Maven 4 also supports a project level (${maven.project.conf}/settings.xml and ${maven.project.conf}/extensions.xml per Constants.MAVEN_PROJECT_SETTINGS / Constants.MAVEN_PROJECT_EXTENSIONS). The Properties section already describes the three-tier model, so mentioning the project tier in Settings/Extensions would make the document internally consistent. But that's a separate improvement — this PR is a clear net positive as-is.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

elharo and others added 4 commits July 30, 2026 19:33
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

@gnodet gnodet 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.

The new commits since our last approval are all correct improvements:

  • Project-level config paths added for Settings (${session.rootDirectory}/.mvn/settings.xml) and Extensions (${session.rootDirectory}/.mvn/extensions.xml) — verified against Constants.java (lines 147, 171) and maven-system.properties (maven.project.conf = ${session.rootDirectory}/.mvn). The path style is consistent with existing docs in the same file (e.g., jvm.config, maven-user.properties).
  • Backtick formatting for DefaultRequestCache class name — correct.
  • Oxford commas in three-item enumerations — appropriate for technical documentation.

Nice work addressing the three-tier configuration model. This now accurately documents all three levels (installation, user, project) for both Settings and Extensions.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

@elharo
elharo merged commit 5ef86b3 into master Jul 30, 2026
23 checks passed
@elharo
elharo deleted the pr-5-8 branch July 30, 2026 20:38
@github-actions

Copy link
Copy Markdown

@elharo Please assign appropriate label to PR according to the type of change.

@github-actions github-actions Bot added this to the 4.1.0 milestone Jul 30, 2026
@elharo elharo added the documentation Improvements or additions to documentation label Jul 30, 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