Fix documentation issues in site docs - #403
Open
elharo wants to merge 6 commits into
Open
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.
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Fixes several documentation issues in the Maven Help Plugin site docs, including link correctness, improved phrasing/grammar, and updated references to external resources.
Changes:
- Adjusted site navigation and documentation wording/grammar across multiple APT pages.
- Updated example prompts and parameter descriptions for clarity/accuracy.
- Updated (or intended to update) FAQ external links (HTTP→HTTPS, JIRA→GitHub).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/site.xml | Fixes the “Configuring Describe Goal” menu link to be relative instead of absolute. |
| src/site/fml/faq.fml | Updates the Maven FAQ link to HTTPS and modifies FAQ content. |
| src/site/apt/usage.apt | Improves wording, example prompts, and clarifies the artifact parameter description. |
| src/site/apt/index.apt.vm | Refines intro text and normalizes grammar/capitalization for goal descriptions. |
| src/site/apt/examples/describe-configuration.apt | Improves phrasing for cmd parameter section and fixes a typo (“paremeter”). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ${project.name} | ||
|
|
||
| The Maven Help Plugin is used to get relative information about a project or the system. It can be used to get a | ||
| The Maven Help Plugin is used to get information about a project or the system. It can be used to get a |
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
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