docs(dev): correct 15.8 developer overview against implementation#449
Open
marevol wants to merge 1 commit into
Open
docs(dev): correct 15.8 developer overview against implementation#449marevol wants to merge 1 commit into
marevol wants to merge 1 commit into
Conversation
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.
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.
Summary
Verified
15.8/dev/overview.rstagainst the Fess source code and corrected several inaccuracies, then propagated the same changes to all language translations.Corrections
org.codelibs.fess.FessBootin the IDE (open http://localhost:8080/), or by usingbin/fessfrom an extracted distribution. Added a note thatmvn packagedoes not producebin/fessin the source tree — the previous instruction (./bin/fessafter building) was misleading.mvn antrun:runstep that downloads the OpenSearch modules and plugins into thepluginsdirectory.Bhv/ConditionBean) are type-safe code generated by DBFlute's FreeGen with ESFlute templates (regenerate withmvn dbflute:freegen).indexer,ingest,script,entity,mylasta,logic) and annotated the DI resource examples.*Test.java) under the defaultbuildprofile, integration tests (*Tests.java) viamvn test -P integrationTests, which require a running Fess server and OpenSearch.AbstractDataStore,ScriptEngine,Ingester) and how web-app plugins extend via Lasta Di component override.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).