apache / apache/lucene

Analysis factories shouldn't have Solr configuration instructions in their javadoc [LUCENE-10249]

Open
#11,285 1 comment 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Major type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

Since the analysis factories were moved into lucene, they have contained an XML snippet in their javadoc showing how to configure them in a `solr.xml` file.  We should either replace this with something showing how to use the factory in a custom analyzer, or just have a plain table of arguments.

---
Migrated from [LUCENE-10249](https://issues.apache.org/jira/browse/LUCENE-10249) by Alan Woodward (@romseygeek)

Contributor guide

Open the contributing guide

Research direction

Start by locating the analysis factory classes and reviewing their current Javadocs for the Solr XML configuration snippets. Replace those instructions with custom-analyzer usage or an arguments table, then verify the generated Javadocs no longer present Solr-specific configuration guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.