uschindler commented on issue #13065: URL: https://github.com/apache/lucene/issues/13065#issuecomment-1938448818
> > How can that be done? > > This is a question that is much harder to answer than I thought... Lucene doesn't have a tutorial/user guide. The only place I could think of was here, in the javadocs: > > https://github.com/apache/lucene/blob/main/lucene/analysis/common/src/java/overview.html > > An alternative would be to include an empty package for Hebrew and only add the package-info.java file, telling folks where they can find downstream Hebrew analyzers. I really don't have any better ideas. It would be better located in the module "analysis" (which is just the parent of all analyzers). Unfortunately this module does not create javadocs, so analysis-common is the only location. I think it would be a good idea to add there a list to external resources of analysis components. Lucene is a flexible library with extension points through SPI, so we can list all external contributions there. This page is also missing an overview on the analysis submodules. An alternative (an in my opinion better) idea is to put a list as Markdown file into the documentation package: https://github.com/apache/lucene/tree/main/lucene/documentation/src/markdown All md files there are compiled to HTML and can be linked in the template file for index.html, too. > How about something with the source maintained in the sandbox dir (along with instructions to build), but no corresponding official release artifact? I don't think this is a good idea. It won't be tested (as we can't run the build) and also it is inconsequent. We had that in the past for the DirectIODirectory and WindowsDirectory. All those were not maintained -- and did not build anymore, although there were build scripts. The Java parts were building, the JNI parts were not longer matching the Java implementations. I may be wrong, but when we looked into this, it was almost impossible to make it work again. Luckily they were rewritten using Java 11+ APIs and are now part of official distribution. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
