Skip to content

docs: fix broken links to non-generated documentation - #12635

Open
elharo wants to merge 4 commits into
masterfrom
pr-1-2
Open

docs: fix broken links to non-generated documentation#12635
elharo wants to merge 4 commits into
masterfrom
pr-1-2

Conversation

@elharo

@elharo elharo commented Jul 30, 2026

Copy link
Copy Markdown
Contributor
  • Remove reference to maven-configuration.html which doesn't exist
  • Comment out API/impl/compat navigation links with explanatory comments
  • Comment out developer docs and Core ITs links

elharo added 2 commits July 30, 2026 16:55
The referenced page does not exist in the site documentation.
API docs, impl docs, compat docs, developer docs and Core ITs are not
generated in this site build. Add comments explaining why they're commented.

@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 index.xml fix (removing the broken maven-configuration.html link) is correct — confirmed HTTP 404 on the live site.

However, the site.xml changes comment out 14 navigation links that all resolve successfully (HTTP 200) on the live Maven site (https://maven.apache.org/ref/4-LATEST/). These Reference links were deliberately fixed just weeks ago by a Maven PMC member (commit 60bc6e4). Commenting them out would degrade documentation navigation for users.

Verified issues:

  1. All 7 Descriptors Reference links work — POM, Settings, Toolchains, Core Extensions, Repository Metadata, Plugin Descriptor, Lifecycle Descriptor all return HTTP 200 under api/.
  2. All 5 Reference links work — Lifecycles, Plugin Bindings, Artifact Handlers, CLI options, Super POM all return HTTP 200 under impl/ and compat/.
  3. Both Development links work — Maven Developer Centre and Core ITs both return HTTP 200.
  4. The added comment "API documentation must be built separately with javadoc:javadoc" is inaccurate — these are Modello-generated descriptor pages (from .mdo model files), not Javadoc.
  5. The PR body references "Fixes #1, #2, #3, #9" but those are unrelated, long-closed issues from 2013.

Suggestion: Keep the index.xml fix for the broken maven-configuration.html link, but drop all site.xml changes since the links work on the live site.

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

Claude Code on behalf of gnodet

@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 new commits did not address our previous feedback. The core issue remains:

14 valid navigation links are still being commented out in site.xml, but all return HTTP 200 on the live site:

  • 7 Descriptors Reference links (POM, Settings, Toolchains, Core Extensions, Repository Metadata, Plugin Descriptor, Lifecycle Descriptor) — all verified HTTP 200 at https://maven.apache.org/ref/4-LATEST/api/
  • 5 Reference links (Lifecycles, Plugin Bindings, Artifact Handlers, CLI options, Super POM) — all verified HTTP 200; these paths were specifically corrected by commit 60bc6e4 (Hervé Boutemy, 2026-06-16) just 6 weeks ago
  • 2 Development links (Maven Developer Centre, Maven Core ITs) — both verified HTTP 200

The only correct change is removing the broken maven-configuration.html link in index.xml (confirmed HTTP 404).

Recommendation: Keep the index.xml fix, revert all site.xml changes. The comment text "API documentation must be built separately with javadoc:javadoc" does not justify removing working navigation from the published site.

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/site.xml
<item name="Repository Metadata" href="./api/maven-api-metadata/repository-metadata.html"/>
<item name="Plugin Descriptor" href="./api/maven-api-plugin/plugin.html"/>
<item name="Lifecycle Descriptor" href="./api/maven-api-plugin/lifecycle.html"/>
<!-- API documentation must be built separately with javadoc:javadoc -->

@hboutemy hboutemy Jul 30, 2026

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.

why removing these link?
they work https://maven.apache.org/ref/4.0.0-rc-6/

Comment thread src/site/site.xml
<item name="Artifact Handlers" href="./impl/maven-core/artifact-handlers.html"/>
<item name="CLI options" href="./compat/maven-embedder/cli.html"/>
<item name="Super POM" href="./compat/maven-model-builder/super-pom.html"/>
<!-- Implementation modules documentation must be built separately -->

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.

why removing these link too?

Comment thread src/site/site.xml
<item name="Maven Developer Centre" href="../../developers/index.html"/>
<item name="Maven Core ITs" href="../../core-its/index.html"/>
<!-- Developer documentation exists in separate repositories -->
<!--item name="Maven Developer Centre" href="../../developers/index.html"/-->

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.

perhaps core-its require update, need to figure out
but developers link is useful (and yes, outside: that's intended)

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