Skip to content

docs: add draft FAQ page and enable link - #12636

Closed
elharo wants to merge 1 commit into
masterfrom
pr-3
Closed

docs: add draft FAQ page and enable link#12636
elharo wants to merge 1 commit into
masterfrom
pr-3

Conversation

@elharo

@elharo elharo commented Jul 30, 2026

Copy link
Copy Markdown
Contributor
  • Creates new src/site/xdoc/faq.xml with basic structure
  • Uncomments FAQ navigation item in site.xml

Fixes #3.

New file src/site/xdoc/faq.xml with basic structure.
Uncommented FAQ navigation item in site.xml.

@gnodet gnodet 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.

The idea of adding a FAQ page is welcome, but the current content has a factual error and formatting inconsistencies:

Verified issues:

  1. Factual error (high): The FAQ states "Maven 4.x requires Java 8 or later" but the project's pom.xml defines <javaVersion>17</javaVersion> — Maven 4.x requires Java 17, not Java 8. This would give users incorrect information.
  2. License header format (medium): The ASF license header is on a single line, while the existing xdoc file (index.xml) uses the standard multi-line format. This is inconsistent with the project's established convention.
  3. Wrong issue reference (low): The PR body says "Fixes #3" but issue #3 is "Reverting some unexpected aether dependency changes to the top-level pom" — an unrelated, already-closed issue. Merging would incorrectly reference that issue.

Please fix the Java version requirement to Java 17 and reformat the license header to match the multi-line format used in src/site/xdoc/index.xml.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

Comment thread src/site/xdoc/faq.xml
<subsection name="Getting Started">

<p><b>Q: What is the minimum Java version required for Maven?</b></p>
<p>A: Maven 4.x requires Java 8 or later. For specific version requirements, see the <a href="https://maven.apache.org/install.html">installation guide</a>.</p>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maven 4.x requires Java 8
😄 ?

@slawekjaranowski

Copy link
Copy Markdown
Member

I would like to managed such FAQ at docs site somewhere: https://maven.apache.org/index.html

We have in many places FAQ which is outdated ... I afraid that this will be also outdated soon 😄

@elharo elharo closed this Jul 30, 2026
@elharo
elharo deleted the pr-3 branch July 30, 2026 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants