slachiewicz opened a new pull request, #1806: URL: https://github.com/apache/maven-site/pull/1806
Martijn Dashorst ran every command in the guides on Maven 3.9.16, 3.10.0 and 4.0.0-rc-7 and listed 48 places where the documentation and Maven disagree. Most were fixed on master over the last days; this PR fixes the ones left in maven-site. Every behaviour claim was checked again by running Maven 3.9.16, 3.10.0 and 4.0.0-rc-7 (the newest 4.0.0 on Central), using small throwaway projects; I can attach the commands and their output on request. | Item | Commit | Change | |---|---|---| | 1 | Show the .mvn directory in the quickstart project trees | The quickstart trees show `.mvn/jvm.config` and `.mvn/maven.config`; the archetype's three "Don't override file" warnings are explained. | | 6 | Say which later phases Maven 4 runs with compile and prepare-package | On 4.0.0-rc-7, `mvn compile` also runs `process-classes` and `mvn prepare-package` runs `jar:jar`; 3.9 and 3.10 do neither. | | 7 | Say that the filters and assembly directories are conventions only | `src/main/filters`, `src/test/filters` and `src/assembly` are conventions; no plugin reads them by default. | | 30, 31 | Describe what Maven 4.0.0-rc-7 deploys and accepts for consumer POMs and parents | *What's new in Maven 4* now describes observed behaviour: `*-build.pom` is deployed with and without flattening, the consumer POM keeps `<parent>` without flattening, `<parent/>` is accepted under model 4.0.0, and a dependency on a subproject without a version still needs 4.1.0. | | 37, 38 | Document Maven 4's toolchains options and the other jdkToolchain plugins | `-it`/`--install-toolchains` and the deprecated `-gt`, JDK discovery and `select-jdk-toolchain` (toolchains plugin 3.2.0), `jdkToolchain` in Surefire, Failsafe and Javadoc. | | 48 | Expand the documentation style guide | Voice, kinds of pages, stating Maven versions, running what a page shows, URLs and anchors, code block languages, alt text. | | — | Make the 4.x checkbox of the reference documentation helper large enough to tap | 24×24 px, so the page passes axe `target-size`. | | — | Fix three in-page anchors in the getting-started guide | Three links pointed at ids that don't exist. | **For a reviewer with Maven 4 knowledge (items 30 and 31):** the page now says what 4.0.0-rc-7 does. If the earlier text described the intended behaviour, these are Maven bugs rather than documentation fixes, and the page should say so instead. Checks: the site renders; compared with master no published URL or content anchor is lost and nothing loads from outside apache.org; `.github/accessibility/check.mjs` reports 0 violations on all 300 pages, and with the skin rules switched on the `#v4x` `target-size` violation is gone. --- To make clear that you license your contribution under the [Apache License Version 2.0, January 2004](https://www.apache.org/licenses/LICENSE-2.0) check one of the following: - [x] I hereby declare this contribution to be licensed under the [Apache License Version 2.0, January 2004](https://www.apache.org/licenses/LICENSE-2.0) - [ ] I hereby declare that I have filed an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
