nasa-gcn / gcn.nasa.gov

General Coordinates Network (GCN) web site
https://gcn.nasa.gov
Other
179 stars 43 forks source link

Circulars - Lucene search documentation #2502

Open tylerbarna opened 1 month ago

tylerbarna commented 1 month ago

Description

This adds basic documentation for the Lucene search, hidden behind a feature flag.

Related Issue(s)

2288, #2501

Testing

  1. Add CIRCULARS_LUCENE feature flag to .env

  2. Navigate directly to http://localhost:3333/docs/circulars/lucene

  3. Read Documentation

  4. Remove CIRCULARS_LUCENE feature flag from .env

  5. Navigate directly to http://localhost:3333/docs/circulars/lucene

  6. Page should not load

tylerbarna commented 1 month ago

Please take a look at https://ui.adsabs.harvard.edu/help/search/search-syntax for some ideas for how to structure this documentation page.

On the search page itself, I'd like to have a one-page quick reference (could be a modal or a disclosure section expanded by clicking a button) that is similar to the examples on ADS: Screenshot 2024-08-01 at 12 33 53

I agree on the point regarding modal quick selection; I was planning on implementing that in a separate PR

tylerbarna commented 1 month ago

Adding filtering by date range as part of the lucene syntax would likely be a separate PR as well to ensure it ties in with the existing feature correctly

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 6.10%. Comparing base (cfd0c49) to head (d8f5ae5). Report is 48 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2502 +/- ## ======================================== + Coverage 5.26% 6.10% +0.84% ======================================== Files 158 164 +6 Lines 3912 4061 +149 Branches 419 442 +23 ======================================== + Hits 206 248 +42 - Misses 3705 3811 +106 - Partials 1 2 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.