Repository navigation
docs: move the unreleased changes under 0.6.4, restructure the README and the longer pages, and bring the data they quote up to date - #123
Merged
Conversation
… and the longer pages, and bring the data they quote up to date After the release: - `docs/changes.md` and its translation: "Unreleased" becomes 0.6.4 (2026-11-03), and the sentence about `main` being ahead of the latest release goes. - `docs/troubleshooting.md` and its translation: the three "Unreleased: release 0.6.3 ..." remarks about checksums go. - `docs/development.md` and its translation: "Releasing" now holds what the README said about the shared workflow, and "After a release" lists the steps (changes.md, the previous release number, the quoted data). Reading order: - `README.md` and `README_CN.md` start with install and usage, then versions and short names, then the topics, "Coming from SDKMAN" (shorter, in two paragraphs) and a "Documentation" list that names every page, grouped by what a reader wants. The pointer-only sections and the maintainers' "Releasing this plugin" are gone from the README. The table of short names is unchanged, as the notes of `vfox add java` link to it. - `docs/native-image.md` and its translation are new. They hold the section that was at the end of the GraalVM family in `distributions.md`, in the same words, under headings for Ubuntu, other systems, GraalVM CE 8 to 19 and what was checked. `distributions.md` now lists the GraalVM distributions first and the explanations of their numbers after them. - `docs/foojay.md` puts the queries a reader can run before what the plugin asks and how it checks downloads. `docs/e2e.md` puts how to run the suite before the list of what it verifies. The headings are the same, so links to them still work. - `docs/platforms.md` has one list of notes with one date instead of two. Data: the platform table, the JavaFX table, the places Foojay links each distribution to, the number of distributions and SDKMAN's short names were compared with Foojay and SDKMAN on 2026-11-03 and are unchanged. What changed and is updated: Zulu has Java 27 for Windows ARM64, `java@21-tem` is `21.0.13+9-tem`, `java@28.ea-open` is `28-ea+21`, `java@25-graal` is `25.0.5.0.3-graal`, and `vfox search java all` lists about 2,600 lines. The dev container also carries vfox now, which `docs/e2e.md` did not say. The sections of `foojay.md`, `e2e.md` and `distributions.md` were moved by a script that checks that no line is lost, and the relative links and anchors of all 33 pages resolve.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
After the release, as for 0.6.2 and 0.6.3:
docs/changes.mdand its translation: "Unreleased" becomes 0.6.4 (2026-11-03). The sentence aboutmainbeing ahead of the latest release goes.docs/troubleshooting.mdand its translation: the three "Unreleased: release 0.6.3 ..." remarks about checksums go.grep -rn -i -e unreleased -e 未发布 docs README*finds only the steps indevelopment.md.docs/development.mdand its translation: "Releasing" now holds what the README said about the shared workflow, and a new "After a release" lists the steps, including the quoted data below.Reading order:
README.mdandREADME_CN.mdstart with install and usage, then versions and short names, then the topics, "Coming from SDKMAN" (now two short paragraphs and the table) and a "Documentation" list that names every page, grouped by what a reader wants. It also linkschanges.md, which the README did not link at all. The sections that only pointed to a page, and the maintainers' "Releasing this plugin", are gone from the README. The table of short names is unchanged, as the notes ofvfox add javalink to it (PLUGIN.notes, checked by the e2e suite), anddevelopment.mdnow says so.docs/native-image.mdand its translation are new. They hold the section that was at the end of the GraalVM family indistributions.md, in the same words, under headings for Ubuntu, other systems, GraalVM CE 8 to 19 and what was checked.distributions.mdnow lists the GraalVM distributions first and the explanations of their numbers after them, with a pointer at the top.docs/foojay.mdputs the queries a reader can run before what the plugin asks and how it checks downloads.docs/e2e.mdputs how to run the suite before the list of what it verifies. The headings are unchanged, so links to them still work.docs/platforms.mdhas one list of notes with one date, instead of two lists with two.The sections of
foojay.md,e2e.mdanddistributions.mdwere moved by a script that checks that no line is lost (the diff ofe2e.mdandfoojay.mdis large because git does not show a move). The only line-level changes in those three pages are the ones above, the new pointers and the data below.Data, all compared on 2026-11-03:
development.md), the JavaFX table, where Foojay links each distribution to (mirror.md), the number of distributions, SDKMAN's short names, the "Only some releases" notes except the one below, the "Other CPUs" list, and that Red Hat's Linux arm64, ppc64le and Windows downloads still answer 404.java@21-temis21.0.13+9-tem,java@28.ea-openis28-ea+21,java@25-graalis25.0.5.0.3-graal(Foojay lists the 25.0.5 builds25.0.5.0.2and25.0.5.0.3now), andvfox search java alllists about 2,600 lines, all asvfox plugin runand Foojay answer them today. The dev container carries vfox since 0.6.4, whichdocs/e2e.mddid not say.vfox plugin test .passes, and the relative links and anchors of all 33 Markdown files resolve (a script that follows GitHub's rules for the anchors of headings; it was clean before the change too). The English and Chinese pages have the same headings, tables and code blocks apart from translated comments.Noticed while checking, and not changed here: SDKMAN lists Oracle GraalVM as
25.0.5.0+3-graal, which looks like Foojay's25.0.5.0.3. With only25.0.5.0.3-graalinstalled, a.sdkmanrcwithjava=25.0.5.0+3-graalselects it, but with25.0.5-graalinstalled as well, it selects25.0.5-graal. That may be intended, as the plugin reads the number after+as SDKMAN's own build count, seedocs/sdkmanrc.md.