bonitasoft / bonita-documentation-theme

Dedicated Antora UI Bundle used to produce the Bonita Documentation
https://bonitasoft.github.io/bonita-documentation-theme/
Mozilla Public License 2.0
4 stars 7 forks source link

Enable site-wide search #134

Open tbouffard opened 3 years ago

tbouffard commented 3 years ago

Currently, the search is only applied to the version of the component to which the page belongs. Providing a way to search on all components (only their latest version) would allow to broaden the search.

Asciidoctor does the opposite: by default search in all components, but provide a checkbox to restrict the search to the current component.

https://docs.asciidoctor.org/asciidoc/latest/

asciidoctor_search

alachambre commented 3 years ago

The use case is different: It allows to use the search on all the projects or not (the projects available in the menu -> asciidoctor.js, asciidoctorJ ...). We could offer the possibility to search on Bonita, bcd, cloud and bici, but the difference between us and asciidoctor is that we have several versions for each projects, so it opens the door for duplicate.

I think the use case isn't that interesting, and is complicated to manage correctly.

tbouffard commented 3 years ago

The use case is different: It allows to use the search on all the projects or not (the projects available in the menu -> asciidoctor.js, asciidoctorJ ...).

I don't understand why it is different, they have projects, we have components: bonita, labs, bcd, bcloud Notice that I didn't say we should use a checkbox to choose to search only on the current component (and version). This may be whatever solution.

... but the difference between us and asciidoctor is that we have several versions for each projects, so it opens the door for duplicate.

This why I proposed in the description search on all components (only their latest version) 😸

I think the use case isn't that interesting, and is complicated to manage correctly.

I agree that could require some development/conifiguration, but about the need, I guess this could help when the user is reading the BCD or Bonita Cloud and need more details from the Bonita Platform documentation. The new feature would let get the information by searching from the BCD/BCloud page and reach the Bonita page. Currently, we have to 1st go to the Bonita Platform documentation and then perform a search.

tbouffard commented 3 years ago

Search on the whole https://docs.couchbase.com/home/index.html and filter by component and version

couchbase_search_20211110