Maven features + search

Question

Recently, in our organization, we decided to work with the maven site plugin and maintain all the documentation about our project on the site created by maven. However, I did not find a way to add a search function, the only thing I found was that some skins provide integration with the Google search engine, but I cannot use it because we work on our own network and there is no way to make it “indexable” from the outside.

So my question is: can anyone suggest a solution for the descent? I was thinking of developing my maven plugin that would launch lucene and index everything by itself, and then provide an API to use this search from the site, but I hope I don't need to reinvent the wheel :) So any suggestion would be welcome here

Thank you in advance

Answer 1

Just an idea, you can try using a full-text search engine based on JavaScript, for example. http://jssindex.sourceforge.net/

Answer 2

We use constellio to index a published site on a schedule. It works well.

I picked up http://jira.codehaus.org/browse/MSKINS-88 to enable the addition of a common search form in liquido skin , which we use to create our maven sites. We hope that this will be achieved, and we may have a search form baked in the documentation.

Answer 3

I know this is an old question, but a very simple (and admittedly ugly) way to accomplish what you want is to simply create a PDF file with the contents of the site and allow users to search the PDF file. The advantage over the search on the generated site is that any PDF reader will be able to search the entire document.

mvn pdf:pdf 

Answer 4

If you cannot use Google Site Search, you are dependent on local search implementations. Therefore, you need to either build the index during the assembly of the site (and so that it is available as part of your site), or do both the index and the search in the browser.

Besides JSSindex, which seems to be a bit dated there http://www.tipue.com/search/ , which is based on jQuery.

Answer 5

The Maven site plugin approach is not widely used. So there is nothing special for indexing yet. You should look at tools other than maven.