Skip to content

docs(15.10): fix version statements copied from 15.9 and short heading underlines - #619

Merged
marevol merged 1 commit into
mainfrom
docs/fix-15.10-copied-version-statements
Oct 26, 2026
Merged

marevol merged 1 commit into
mainfrom
docs/fix-15.10-copied-version-statements

Conversation

@marevol

@marevol marevol commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

Summary

The 15.10 documentation tree (#606) was created by replacing 15.9 with 15.10 in the 15.9 tree. Statements about when something changed therefore named 15.10 for changes that are already in 15.9.0 (or older), and some headings got a short underline. This PR fixes them in the 15.10 tree of all seven languages (ja, en, de, fr, es, zh-cn, ko). Nothing outside */15.10/ is touched.

How the versions were decided

Every statement was checked against the fess-15.5.0 to fess-15.9.0 tags of codelibs/fess and the tags of the plugin repositories (fess-ds-gsuite, fess-ds-csv, fess-webapp-bangs, fess-crawler-playwright, docker-fess). A statement was changed only when the change is present in the named tag and absent from the one before it. Changes that really arrived in 15.10 (Apache Tika 4, login form rate limit, client IP in logs, SOCKS5 proxy, image metadata, and so on) are untouched.

Restated as 15.9: vanilla search engine type (search-engine-type, install, install-docker, upgrade), crawler.default.script removal and the Node.js note (crawler-advanced), Groovy as a plugin and the JavaScript default (scripting-*, ds-json, ds-overview, search-advanced), scheduled jobs using their own script type (scheduler-guide), removal of JAR themes and the JSP search screen, and the spaFallback flag no longer being read (theme-guide, theme-development, plugin-architecture, api-admin-plugin, security-virtual-host, webapp-plugin), bin/fess -v (troubleshooting), the Google Workspace connector rework (ds-gsuite, including the "Changes in" heading and its link), CSV quote handling (ds-csv), encrypted web/file authentication passwords (backup-guide, upgrade), kana mapping (mapping-guide), search history conditions, the search word of click logs, development_mode (api-uiconfig), fess-webapp-bangs (search-bangs), and in the upgrade page the tag_type index in fess_config.bulk (the fess_config.tag_type index is in the fess_config alias of 15.9.0 and not in 15.8.0), chat_log.ndjson (listed in index.backup.log.targets of 15.9.0 and not of 15.8.0), the fess-llm-bedrock plugin and the parts removed from the distribution.

Restated as 15.8: the "Changes in" heading of the Playwright crawler (crawler-advanced), the semantic search integration into the core (rank-fusion, search-semantic, webapp-plugin), and the Entra ID, SAML, SPNEGO and LDAP behavior changes (sso-*, and the feature tasks at the end of the upgrade page).

Restated as 15.6 and 15.7: the separation of the LLM features into fess-llm-* plugins and the rag.llm.name rename (15.6; rag-chat, install-docker, upgrade), and the switch to API v2 and the end of the /api/v1 core API (15.7; api-overview, api-quickstart). The 15.6 and 15.7 trees say the same.

Upgrade page

  • "Upgrading from 15.8 to 15.10" stays. It is the combined section for users coming from 15.8 or earlier (the new "Upgrading from 15.9 to 15.10" section points to it), and its sentences that compare 15.8 with the version you upgrade to (15.10) remain true. Only the sentences that state when a change happened (vanilla, backup contents, encrypted passwords) were corrected.
  • "15.10-Specific Migration Tasks" was a copy of the 15.9 section, and its items are older changes, not changes of 15.10. It is now "Migration Tasks by Feature", and the sentence that points to it is updated. Its sentences "Starting with 15.10, ..." now name the real version.

Heading underlines

Title underline too short warnings that exist in the 15.10 tree but not in the 15.9 tree (net): en 5, ja 4, fr 4, es 4, ko 4, zh-cn 4, de 3. They are fixed (full-width characters count as width 2); headings whose title changed get an underline of exactly the title width. Afterwards each language has the same count as the 15.9 tree, or one less.

Verification

  • docutils (doctitle_xform=False) over all 15.10 files of the seven languages: the total of messages goes from 26676 to 26646, only Title underline too short changes, and no unknown or dangling link target appears.
  • python3 tools/check_headings.py on the seven 15.10 directories, python3 -m unittest discover -s tools and python3 tools/update_eol.py --check pass.
  • Per file, the number of version numbers changed to 15.6, 15.7, 15.8 and 15.9 is the same in all seven languages (checked by script; Spanish ds-gsuite has one sentence without a version number).

Not changed

  • Wording that carries over from the 15.7 tree or older and whose real version the tags do not settle, for example the present-tense "In Fess 15.10, ..." design notes in rag-chat, and the http.proxy note of the LLM clients.
  • References to the current version: file and image names, fess-15.10.0, plugin versions, the supported OpenSearch version, "Fess 15.10 or later is installed" in the SSO pages, and version examples in API responses.

…g underlines

The 15.10 tree was created from the 15.9 tree by replacing 15.9 with 15.10,
so statements about when something changed named the wrong version.

- Restate changes that are already in the 15.9.0 release as 15.9: vanilla
  search engine type, removal of crawler.default.script, the Groovy plugin
  and the JavaScript default, removal of JAR themes and JSP search screens,
  bin/fess -v, the tag_type index and chat_log.ndjson in backups, the
  Google Workspace connector rework, the CSV data store quote handling,
  encrypted web/file authentication passwords, and others.
- Restate changes that came with 15.8 as 15.8: the Playwright crawler
  changes, the Kerberos realm check of SPNEGO, SAML response binding,
  Entra ID response mode and background group resolution, LDAP permission
  names, and the semantic search integration into the core.
- Restate the separation of the LLM plugins and the rag.llm.name rename as
  15.6, and the API v2 as 15.7.
- Rename the "15.10-Specific Migration Tasks" heading of the upgrade page
  to "Migration Tasks by Feature", because the tasks are older changes. The
  combined "Upgrading from 15.8 to 15.10" section keeps its title and its
  wording about the target version.
- Extend the heading underlines that became too short, and shorten those of
  the headings whose version number got shorter.

Only the 15.10 tree of the seven languages is changed.
@marevol
marevol force-pushed the docs/fix-15.10-copied-version-statements branch from 5620486 to 75aa683 Compare October 25, 2026 21:49
@marevol
marevol removed this pull request from stack #622 October 25, 2026 21:49
@marevol
marevol added this pull request to stack #623 October 26, 2026 13:55
@marevol
marevol merged commit cd981b2 into main Oct 26, 2026
2 checks passed
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.

1 participant