Skip to content

docs(dev): correct 15.8 developer overview against implementation#449

Open
marevol wants to merge 1 commit into
masterfrom
docs/15.8-dev-overview
Open

docs(dev): correct 15.8 developer overview against implementation#449
marevol wants to merge 1 commit into
masterfrom
docs/15.8-dev-overview

Conversation

@marevol

@marevol marevol commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Verified 15.8/dev/overview.rst against the Fess source code and corrected several inaccuracies, then propagated the same changes to all language translations.

Corrections

  • Development run instructions: The dev server is started by running org.codelibs.fess.FessBoot in the IDE (open http://localhost:8080/), or by using bin/fess from an extracted distribution. Added a note that mvn package does not produce bin/fess in the source tree — the previous instruction (./bin/fess after building) was misleading.
  • Build prerequisite: Added the first-time mvn antrun:run step that downloads the OpenSearch modules and plugins into the plugins directory.
  • Maven prerequisite: The build does not enforce a minimum Maven version; changed the hard "3.9 or higher" claim to "a recent 3.x that supports Java 21 is recommended".
  • Data access layer: Clarified that OpenSearch access classes (Bhv / ConditionBean) are type-safe code generated by DBFlute's FreeGen with ESFlute templates (regenerate with mvn dbflute:freegen).
  • Directory structure: Added previously omitted top-level packages relevant to developers (indexer, ingest, script, entity, mylasta, logic) and annotated the DI resource examples.
  • Testing: Documented how tests actually run — unit tests (*Test.java) under the default build profile, integration tests (*Tests.java) via mvn test -P integrationTests, which require a running Fess server and OpenSearch.
  • Extension points: Noted the base class/interface for each plugin type (AbstractDataStore, ScriptEngine, Ingester) and how web-app plugins extend via Lasta Di component override.
  • Prerequisites / notes: Added OpenSearch as a runtime prerequisite and a note on the war-to-jar packaging step for building plugins locally.

Languages

Applied to ja, en, de, es, fr, ko, zh-cn. Japanese is the source of truth; translations were verified for structural and semantic parity, and all files parse cleanly (no structural RST warnings).

Verify the developer overview against the Fess source code and correct
inaccuracies, then propagate the same changes to all translations.

- Fix the development run instructions: run org.codelibs.fess.FessBoot in
  the IDE (or use bin/fess from an extracted distribution). Note that
  `mvn package` does not create bin/fess in the source tree.
- Add the first-time `mvn antrun:run` step to download the OpenSearch
  modules and plugins.
- Correct the Maven prerequisite: the build does not enforce a minimum
  version (a recent 3.x that supports Java 21 is recommended).
- Clarify that the data access layer is type-safe OpenSearch access
  generated by DBFlute FreeGen with ESFlute templates.
- Expand the directory structure with previously omitted packages
  (indexer, ingest, script, entity, mylasta, logic).
- Document integration-test execution (`mvn test -P integrationTests`)
  and the default unit-test profile.
- Add the OpenSearch runtime prerequisite and a note on the war-to-jar
  packaging step for building plugins locally.
- Apply the same corrections to en, de, es, fr, ko, and zh-cn.
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