Skip to content

NMS-13540: Highlight search terms in result page#21

Open
fooker wants to merge 1 commit intomasterfrom
jira/NMS-13540
Open

NMS-13540: Highlight search terms in result page#21
fooker wants to merge 1 commit intomasterfrom
jira/NMS-13540

Conversation

@fooker
Copy link
Member

@fooker fooker commented Dec 13, 2022

This changes the version of antora-lunr-extension to our own for which implements the required functionality: https://github.com/opennms-forge/antora-lunr-extension.

To use the changes in antora-lunr-extension, the builder image has to be updated, too.
See opennms-forge/opennms-base-container#26.

In addition, a PR for upstream has been created: https://gitlab.com/antora/antora-lunr-extension/-/merge_requests/90.

@fooker fooker requested review from Bonrob2 and indigo423 December 13, 2022 09:46
@fooker fooker force-pushed the jira/NMS-13540 branch 7 times, most recently from a89c0a3 to 9091c08 Compare December 13, 2022 13:10
Copy link
Contributor

@Bonrob2 Bonrob2 left a comment

Choose a reason for hiding this comment

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

Not able to test this, but thanks for doing all the work.

@fooker fooker force-pushed the jira/NMS-13540 branch 4 times, most recently from 98fafa7 to 3bacf95 Compare January 26, 2023 09:54
@marshallmassengill
Copy link
Contributor

@indigo423 this might be worth merging in but I suspect we would want to close this one and pick up something that doesn't have the conflicts.

@indigo423
Copy link
Member

@marshallmassengill, that was an enhancement @fooker implemented to the JavaScript-based search in our docs theme. This is now 3 years old, and there is a good chance this is solved differently.

Some context: As it is today, we build the search index when the docs are built. The search is implemented in JavaScript on the client. The benefit, we don't have to deal with an external service like Agolia to manage indexing and search as a third-party. The downside is larger downloads and a bit less sophisticated search capabilities.

We have picked the simpler approach to begin with. Re-evaluating the search strategy to fit the capabilities of Antora and external search providers like Agolia could make sense. We are at least 5 years behind the capabilities of Antora and indexing services like Agolia.

@marshallmassengill
Copy link
Contributor

Yeah, modernizing the docs (and in particular the search) would be a good quality of life improvement for all of our users. I'm good with a different approach but I saw this in here as I was mucking about yesterday and figured I'd suggest it since it's been out here and stale.

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.

4 participants