Skip to content

Fix errors, typos, grammar, and broken link in site documentation - #633

Open
elharo wants to merge 6 commits into
masterfrom
fix-site-issues
Open

Fix errors, typos, grammar, and broken link in site documentation#633
elharo wants to merge 6 commits into
masterfrom
fix-site-issues

Conversation

@elharo

@elharo elharo commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Fixes across 5 files:

Errors of fact:

  • index.apt.vm: war:explode -> war:exploded (no such goal)
  • rapid-testing-jetty6-plugin.apt: dead Codehaus link -> Eclipse Jetty docs

Typos:

  • index.apt.vm: developement -> development
  • usage.apt.vm: developement -> development

Grammar:

  • overlays.apt.vm: artifacts matches -> artifacts match

Awkward phrasing:

  • overlays.apt.vm: controlled the regular way -> controlled in the regular way
  • war-manifest-guide.apt.vm: clarified note about dependency inclusion

@elharo elharo added the documentation Improvements or additions to documentation label Jul 24, 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 WAR Plugin site documentation to correct typos/grammar, fix a broken external link, and improve the accuracy/clarity of goal references and notes.

Changes:

  • Fixes multiple spelling/grammar issues across APT docs (e.g., “development”, “artifacts match”, phrasing tweaks).
  • Updates the goals overview text to correct an incorrect goal reference.
  • Rewords a note in the WAR manifest guide for clearer meaning and updates the Jetty plugin documentation link.

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/apt/usage.apt.vm Corrects a typo in the “development” wording in the war:exploded usage section (but still needs a goal-name fix).
src/site/apt/overlays.apt.vm Grammar and phrasing fixes in overlay configuration documentation.
src/site/apt/index.apt.vm Corrects “development” typo and updates war:inplace description to reference the correct goal.
src/site/apt/examples/war-manifest-guide.apt.vm Clarifies a note about dependency inclusion vs manifest classpath.
src/site/apt/examples/rapid-testing-jetty6-plugin.apt Replaces a dead Codehaus link with a new Jetty plugin documentation URL (but currently mismatched to Jetty 6 example coordinates).

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

Comment thread src/site/apt/usage.apt.vm Outdated
Comment thread src/site/apt/index.apt.vm Outdated
The command will block with Jetty listening on port 8080.

Check the {{{http://docs.codehaus.org/display/JETTY/Maven+Jetty+Plugin}Jetty Plugin documentation}} for more details.
Check the {{{https://jetty.org/docs/jetty/12/programming-guide/maven-jetty/jetty-maven-plugin.html}Jetty Plugin documentation}} for more details.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@copilot your suggested link does not point to the docs. Do you have a better one?

@elharo
elharo requested a review from Tibor17 July 24, 2026 11:36
elharo and others added 4 commits July 24, 2026 13:51
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>

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

Suppressed comments (3)

src/site/apt/examples/rapid-testing-jetty6-plugin.apt:75

  • This page configures the legacy Jetty 6 plugin (org.mortbay.jetty:maven-jetty-plugin:6.1.10), but the link points to the Jetty 12 Maven plugin docs, which uses different coordinates and configuration and is likely to confuse readers. Consider linking to an archived copy of the original Jetty 6 Maven plugin documentation instead.
  Check the {{{https://jetty.org/docs/jetty/12/programming-guide/maven-jetty/jetty-maven-plugin.html}Jetty Plugin documentation}} for more details.

src/site/apt/usage.apt.vm:134

  • The line wrap/indentation here breaks the paragraph formatting within the list item (the continuation line is less indented), and the wording is slightly inaccurate: the war:exploded goal creates an exploded webapp directory (see WarExplodedMojo), not a WAR file "in exploded form".
  To speed up testing during the development phase, <<<war:exploded>>> can generate the WAR in exploded
 form.
 Use the same project as above and invoke:

src/site/apt/index.apt.vm:45

  • This bullet is indented one space more than the other items in the same list, which will render it as a nested list item in APT rather than a peer item.
  * {{{./inplace-mojo.html}war:inplace}} is another variation of <<<war:exploded>>> 

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.

2 participants