Fix documentation issues in site docs - #403
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 |
ascheman
left a comment
There was a problem hiding this comment.
Thanks a lot for taking this on, Elliott — this is genuinely useful cleanup across the site docs, and the changes that land here are all good: the /examples/… leading-slash fix in site.xml, the ```sh fences and the wording/typo fixes in describe-configuration.md, and the https + obsolete-FAQ trim in faq.fml. No objection to any of that.
One thing worth rescuing before this merges, though: the branch predates Sylwester's APT→Markdown port on master (7ec66ea4, plus the rename in b28a8f8a). Because your index.apt.vm / usage.apt edits were made against files that no longer exist, the merge quietly dropped them — the net diff here only touches three files, and the improvements you describe for index and usage aren't actually in it. All the wording you fixed is still present on master, e.g.:
src/site/markdown/index.md: "relative information", "a Plugin", "as an XML"src/site/markdown/usage.md: "minimalist configurations", "refers to ask expressions", "current pom"
Could you re-apply just those index/usage edits on top of current master (against the .md files now)? It should be quick — the target text is unchanged, only the file format moved — and it'd be a shame to lose that part of your work. Happy to re-review as soon as it's rebased. 🙏
|
Thanks for calling my attention to that, but it's a lot easier to redo that separately than manually merge each change into this PR. |
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