docs(dev): correct 15.8 plugin architecture guide against implementation#448
Merged
Conversation
Verified the developer plugin-architecture guide against the current source and corrected several inaccuracies, then propagated the changes to all languages (ja, en, de, fr, es, ko, zh-cn). - Plugin types: list all categories recognized by PluginHelper.ArtifactType (data store, web app, script, ingest, theme, thumbnail, LLM, crawler) with their artifact prefixes - Plugin structure: use the real fess-ds-example layout and add the fess_ds++.xml registration file (removed the non-existent ExampleDataStore(Handler) file) - pom.xml: inherit from fess-parent and use provided scope for fess and opensearch - Registration: document the "++" DI merge convention (fess_ds++.xml etc.); fix register() to call ComponentUtil.getDataStoreFactory() and clarify it runs via the <postConstruct> element, not the Java @PostConstruct annotation - storeData(): correct the signature to DataStoreParams and use getAsString(); getName() is protected - Install: install from the admin console (select from repository list or upload a JAR) or copy the JAR to app/WEB-INF/plugin/; removed the non-existent CLI command - Reference the IDE boot class org.codelibs.fess.FessBoot and add links to theme-development and the plugin installation guide
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
Reviewed the developer plugin-architecture guide (
15.8/dev/plugin-architecture.rst) against the current Fess source code and corrected several inaccuracies, then propagated the corrected content to all languages (ja, en, de, fr, es, ko, zh-cn). The Japanese version was verified first and used as the source for the translations.Corrections
PluginHelper.ArtifactType(data store, web app, script engine, ingest, theme, thumbnail, LLM, crawler) with their artifact-name prefixes, and noted the list is not exhaustive.fess-ds-examplestructure and added thefess_ds++.xmlregistration file. Removed the non-existentExampleDataStoreHandler.java.fess-parentand declarefess/opensearchwithprovidedscope (matching the real reference plugin).++DI merge convention (fess_ds++.xml,fess_se++.xml,fess_ingest++.xml,fess_llm++.xml,app++.xml). Fixedregister()to callComponentUtil.getDataStoreFactory().add(getName(), this), and clarified it runs via the<postConstruct>element rather than the Java@PostConstructannotation.DataStoreParams(notMap<String, String>) andgetAsString()for parameter access;getName()isprotected.app/WEB-INF/plugin/. Removed the non-existent CLI command.org.codelibs.fess.FessBoot, refreshed the published-plugin list, and added links totheme-developmentand the plugin installation guide.Verification
fess-ds-example,AbstractDataStore,PluginHelper,ResourceUtil, andAdminPluginAction.:doc:targets,|Fess|substitutions), no residual source-language text, proper diacritics for de/fr/es, and valid RST section underlines.