Fix doc issues - #423
Merged
Merged
Conversation
- Fix broken link in site.xml (remove leading / from href) - Fix awkward phrasing: 'relative information' -> 'information' - Fix inconsistent capitalization: 'Plugin' -> 'plugin' - Fix grammar: 'as an XML' -> 'as XML' - Fix awkward phrasing: 'minimalist configurations' -> 'basic configuration' - Fix grammar: 'refers to ask expressions' -> 'is used to evaluate expressions' - Fix: 'current pom' -> 'current project's POM' - Fix: 'You could' -> 'You can' for clarity - Fix: 'i.e.' -> 'e.g.' where examples are given - Fix unclear/awkward sentence about mvn command - Fix typo: 'paremeter' -> 'parameter' - Fix insecure link: http -> https for maven.apache.org - Fix broken JIRA link -> GitHub Issues
Reword description of the Maven Help Plugin for clarity.
ascheman
approved these changes
Aug 19, 2026
ascheman
left a comment
ascheman
left a comment
There was a problem hiding this comment.
Content LGTM. This correctly redoes the #403 broken-link fix on the new markdown docs (drops the leading / in the describe-configuration menu link in site.xml), switches the shell snippets from ```unknown to ```sh, removes the obsolete FAQ and its menu item (no dangling faq.html references left), and tightens the prose (active voice, drops "i.e.", fixes "paremeter").
Two small things, neither blocking:
- Nit: in
describe-configuration.md, the two reworded lines ("If you don't provide a parameter," / "descriptions:") picked up a stray leading space. - Could you squash on merge? The branch currently carries 3
mergecommits plus several micro-commits — a single clean commit would keep the history linear.
Approving so it isn't held up on the above.
Contributor
Author
|
squash and merge happens on merge, that's what the button is for. If I had my druthers it would be the only button. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes several issues in the site documentation files:
site.xml
href="/examples/describe-configuration.html"had a leading/, making it an absolute path from the site root. Changed to relativehref="examples/describe-configuration.html"to match the other menu entries.index.apt.vm
usage.apt
describe-configuration.apt
mvncommandfaq.fml
http://→https://for maven.apache.org link