Skip to content

[ZEPPELIN-6436] Fix stale module names and test commands in embedding search documentation - #5408

Merged
tbonelee merged 2 commits into
apache:masterfrom
gjenfwo:ZEPPELIN-6436-fix-embedding-search-docs
Aug 9, 2026
Merged

[ZEPPELIN-6436] Fix stale module names and test commands in embedding search documentation#5408
tbonelee merged 2 commits into
apache:masterfrom
gjenfwo:ZEPPELIN-6436-fix-embedding-search-docs

Conversation

@gjenfwo

@gjenfwo gjenfwo commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

What is this PR for?

docs/embedding-search.md still referenced the zeppelin-zengine module, which was merged into zeppelin-server in ZEPPELIN-6355 before the embedding search feature was added in ZEPPELIN-6411. As a result, the implementation paths and the mvn test -pl zeppelin-zengine commands in the doc no longer match the current repository layout and the test commands fail as written. This PR updates the stale references so the documentation is accurate and the test commands actually run.

What type of PR is it?

Documentation

Todos

  • Replace zeppelin-zengine references with zeppelin-server in implementation paths
  • Update mvn test -pl commands to target zeppelin-server
  • Verify referenced source/test files exist at the corrected paths

What is the Jira issue?

ZEPPELIN-6436

How should this be tested?

Confirm no stale references remain: rg -n "zeppelin-zengine" docs/embedding-search.md
image

Optionally
Confirm the corrected paths exist in the repo:
zeppelin-server/src/main/java/org/apache/zeppelin/search/EmbeddingSearch.java
zeppelin-server/src/test/java/org/apache/zeppelin/search/EmbeddingSearchTest.java
zeppelin-server/src/test/java/org/apache/zeppelin/search/LuceneSearchTest.java

Run the corrected commands to confirm they work:
mvn test -pl zeppelin-server -Dtest=LuceneSearchTest
ZEPPELIN_EMBEDDING_TEST=true mvn test -pl zeppelin-server -Dtest=EmbeddingSearchTest

Screenshots (if appropriate)

N/A

Questions:

  • Does the license files need to update? No
  • Is there breaking changes for older versions? No
  • Does this needs documentation? This PR is the documentation fix.

@tbonelee tbonelee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also replace the zeppelin-zengine text in EmbeddingSearchTest.java?

@gjenfwo
gjenfwo force-pushed the ZEPPELIN-6436-fix-embedding-search-docs branch from 9beb6e0 to fe0aaca Compare August 9, 2026 16:15
… search documentation

[ZEPPELIN-6436] Fix stale module names and test commands in embedding search documentation

docs/embedding-search.md still referenced the zeppelin-zengine module, which was merged into zeppelin-server (ZEPPELIN-6355) before the embedding search feature was added.
Update implementation paths, the pom.xml reference, and the mvn test -pl commands to zeppelin-server so the documented commands actually work.
@gjenfwo
gjenfwo force-pushed the ZEPPELIN-6436-fix-embedding-search-docs branch from fe0aaca to 3a6ae48 Compare August 9, 2026 16:24
… search documentation

+ missed one earlier, added one more change.

[ZEPPELIN-6436] Fix stale module names and test commands in embedding search documentation

docs/embedding-search.md still referenced the zeppelin-zengine module, which was merged into zeppelin-server (ZEPPELIN-6355) before the embedding search feature was added.
Update implementation paths, the pom.xml reference, and the mvn test -pl commands to zeppelin-server so the documented commands actually work.
@gjenfwo

gjenfwo commented Aug 9, 2026

Copy link
Copy Markdown
Contributor Author

Could you also replace the zeppelin-zengine text in EmbeddingSearchTest.java?

Thanks for pointing this out. I missed it earlier and added one more change to update the reference in EmbeddingSearchTest.java

@tbonelee
tbonelee merged commit a403bed into apache:master Aug 9, 2026
16 of 18 checks passed
@tbonelee

tbonelee commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Merged into master

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.

2 participants