Add ability to search documentation

CraigClark commented 7 months ago

OP timer

https://openplus.monday.com/boards/4092908516/pulses/6413878020

User story

As an editor, I want to quickly find items in the documentation so that i can work quickly and accurately with minimal disruption.

Describe the idea

Currently the documentation page has 5 top level pages and close to 80 sub pages. This means that a user would have to have some idea where in the tree they can find the information they need.

If we add a search block above the side index on on internal pages and on the front page of the index page, it could help people find things.

Actions

[x] A new search index for the documentation
[x] a block with the search field in it
[x] a view to display results (Title, link and summary if present)
[x] Add Documentation book outline to results page
[x] theme adjustments @CraigClark
[ ] ~~while not necessary, it would be a good idea if someone when through and added a summary for each help page.~~ not necessary as we are using a search snippet on the results page
[x] Document new block bcbb_book_navigation in bcbb @CraigClark

Example of search box

search-docs

lkmorlan commented 7 months ago

Instructions for creating a search_api processor, which is needed for limiting the search to a single book.

lkmorlan commented 7 months ago

For now, we will not limit to a single book. This has been documented as a known issue in the wiki.

The rest of this ticket is for @CraigClark.

CraigClark commented 6 months ago

Blocked, pending #460

CraigClark commented 6 months ago

@lkmorlan ready for merge/review https://github.com/bcgov/MFIN-Data-Catalogue/tree/426-search-docs

CraigClark commented 6 months ago

Currently the book content type is used exclusively for the documentation pages. If, at some point in the future, there is a need for more books , more development work will be required. This is mentioned in the user documentation in the wiki for developers.

lkmorlan commented 6 months ago

Merged

NicoledeGreef commented 6 months ago

reviewed in dv14

CraigClark commented 6 months ago

We have added a reset button that needs to be themed. @CraigClark

CraigClark commented 6 months ago

@lkmorlan reset button is themed here https://github.com/bcgov/MFIN-Data-Catalogue/tree/426-reset-button-search-docs please review/merge

lkmorlan commented 6 months ago

Merged

NicoledeGreef commented 6 months ago

verified in dv14.

tried security classification and "security classification". results were as anticipated.

bcgov / MFIN-Data-Catalogue