Skip to content

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
linghengqian merged 1 commit into
mainfrom
docs/refresh-after-0.6.4
Nov 3, 2026
Merged

linghengqian merged 1 commit into
mainfrom
docs/refresh-after-0.6.4

Conversation

@linghengqian

Copy link
Copy Markdown
Member
  • 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.

After the release, as for 0.6.2 and 0.6.3:

  • docs/changes.md and its translation: "Unreleased" becomes 0.6.4 (2026-11-03). 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. grep -rn -i -e unreleased -e 未发布 docs README* finds only the steps in development.md.
  • docs/development.md and 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.md and README_CN.md start 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 links changes.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 of vfox add java link to it (PLUGIN.notes, checked by the e2e suite), and development.md now says so.
  • 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, with a pointer at the top.
  • 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 unchanged, so links to them still work.
  • docs/platforms.md has one list of notes with one date, instead of two lists with two.

The sections of foojay.md, e2e.md and distributions.md were moved by a script that checks that no line is lost (the diff of e2e.md and foojay.md is 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:

  • Unchanged: the platform table (31 distributions by 8 platforms, with the script of 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.
  • 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 (Foojay lists the 25.0.5 builds 25.0.5.0.2 and 25.0.5.0.3 now), and vfox search java all lists about 2,600 lines, all as vfox plugin run and Foojay answer them today. The dev container carries vfox since 0.6.4, which docs/e2e.md did 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's 25.0.5.0.3. With only 25.0.5.0.3-graal installed, a .sdkmanrc with java=25.0.5.0+3-graal selects it, but with 25.0.5-graal installed as well, it selects 25.0.5-graal. That may be intended, as the plugin reads the number after + as SDKMAN's own build count, see docs/sdkmanrc.md.

… 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.
@linghengqian
linghengqian merged commit 4557880 into main Nov 3, 2026
11 checks passed
@linghengqian
linghengqian deleted the docs/refresh-after-0.6.4 branch November 3, 2026 05:22
@linghengqian linghengqian added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant