[FOLIO-3311] Enable dev.f.o search index to include specific remote important documents Created: 12/Oct/21  Updated: 22/Oct/21  Resolved: 12/Oct/21

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: TBD
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devweb
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-3312 Use GitHub Workflow to gather specifi... Open
Sprint: DevOps Sprint 125
Development Team: FOLIO DevOps

 Description   

As explained with the FAQ Where is developer documentation located, the module documentation lives with each actual module.

The dev.f.o Search facility does index only the content that is part of the dev website.

Its Search other section provides example searches for module documentation by using GitHub search facilities.

It would be beneficial to enable the dev.f.o Search facility to also index a specific set of important remote documents, for example "Okapi Guide", "RMB README", and some important Stripes documentation. When hits are presented for these documents, then provide an obvious link back to the original content.

The search index is generated during the dev site build process. It is a JSON document that is downloaded by the browser when the Search page is visited, and cached if no changes. Those two large documents will double the size of the search index to ~700Kb which should still be okay.

(Thanks to Mike Taylor for the suggestion.)



 Comments   
Comment by David Crossley [ 12/Oct/21 ]

Done.

As explained at the https://dev.folio.org/search/ facility, it is a "prefix-based search". So the search term `accord` will find "Accordion" at stripe-components and "according" in the Okapi Guide. The search terms `accord component` narrows the results.

The set of specific documents are listed here.

Comment by Mike Taylor [ 13/Oct/21 ]

We might also include:

Some of these should be moved out of the project-specific repos where they started life into a more central kocation, but for now that's where they are,

Comment by David Crossley [ 15/Oct/21 ]

Thanks for investigation. That set is now included.

The size of the JSON search index file is now 865K.

Comment by Mike Taylor [ 15/Oct/21 ]

Thanks, David!

In 2021, if the size of a file is measured in Kb, it's negligible

Comment by David Crossley [ 22/Oct/21 ]

Thanks for clarifying the size to be a non-concern. (now 1.1M)

I added another set:

Comment by Mike Taylor [ 22/Oct/21 ]

Excellent, thank you for hunting these out!

Generated at Thu Feb 08 23:27:10 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.