Fix documentation issues in site docs

[elharo]

Fixes multiple issues across the site documentation:

index.apt.vm

• Broken link: mail-lists.html → mailing-lists.html (the correct generated page name)
• Insecure link: http:// → https:// for maven.apache.org guide link
• Factual error: 'a single goal' → '2 goals' — the plugin also has a shade:help goal (listed in site.xml)
• Awkward phrasing: Reworded the introductory sentence for clarity

usage.apt.vm

• Omission: Added the 3 missing transformers from org.apache.maven.plugins.shade.resource.properties to the resource transformers table

faq.fml

• Grammar: 'replaces with original' → 'replaces the original'
• Missing word: 'ways choose' → 'ways to choose'

includes-excludes.apt.vm

• Incorrect APT escaping: Fixed \ → \/ so the <excludeDefaults>false</excludeDefaults> element renders correctly

class-relocation.apt.vm

• Typo: org.codehaud → org.codehaus (two occurrences in the example POM)

resource-transformers.apt.vm

• Typo: 'straight forward' → 'straightforward'
• Possessive: 'Mavens' → 'Maven's'
• Copy-paste error: Removed spurious 'NOTICE' from GroovyResourceTransformer description
• Insecure link: http:// → https:// for plugin-tools link
• Unclear phrasing: Reworded the sentence about Class references
• Redundant phrasing: Simplified 'opt to merge them by appending their content into one file'

use-shader-other-impl.apt.vm

• Subject-verb agreement: 'plugin provide' → 'plugin provides'
• Formatting: Extracted prose from inside the +-----+ code block so it renders as text, not code
• Title: 'an other' → 'another'
• Preposition: 'Dependency to' → 'Dependency for'
• Word choice: 'in your job' → 'in your build'

[Copilot]

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.

Updates the Maven Shade Plugin site documentation to fix broken/insecure links, correct factual/grammar issues, and improve clarity/formatting across multiple pages.

Changes:

• Fixed broken/insecure links and corrected factual/grammar issues (e.g., goals count, typos, missing words).
• Improved wording and formatting so examples/text render correctly in APT/FML (escaping, code blocks).
• Expanded documentation to include missing resource transformers.

Reviewed changes

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

Show a summary per file

File	Description
src/site/fml/faq.fml	Fixes schemaLocation URL and improves grammar/clarity in an FAQ answer.
src/site/apt/usage.apt.vm	Adds missing transformer entries and updates package grouping text.
src/site/apt/index.apt.vm	Fixes links, updates goals overview, improves phrasing, and switches to HTTPS.
src/site/apt/examples/use-shader-other-impl.apt.vm	Fixes title/grammar and ensures prose renders outside code blocks.
src/site/apt/examples/resource-transformers.apt.vm	Fixes typos/wording, removes a copy-paste artifact, and switches to HTTPS.
src/site/apt/examples/includes-excludes.apt.vm	Corrects APT escaping so XML renders properly.
src/site/apt/examples/class-relocation.apt.vm	Fixes org.codehaud typo to org.codehaus in example configuration.

---

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