Circulars: Add In-Page Lucene Documentation #2713
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2713 +/- ##
=====================================
Coverage 6.21% 6.22%
=====================================
Files 167 168 +1
Lines 4231 4274 +43
Branches 467 472 +5
=====================================
+ Hits 263 266 +3
- Misses 3966 4006 +40
Partials 2 2 ☔ View full report in Codecov by Sentry. |
I was under the impression we would integrate the quick actions as a separate PR once we figured the proper method out; would we not want to retain the disclosure menu for when those are added? |
I suggested that you make the examples non-clickable, not that you remove them entirely. If we remove the entirely, then there's no need for the additional disclosure section. I would rather that you add them back, but make them non-interactive. |
Ah, apologies for the misunderstanding. I'll add them back without making them interactive |
this restores the lucene example buttons, but rather than populating the search bar, this copies them to the clipboard. There is not a visual feedback for this at the moment, but something like (https://remix.run/resources/remix-toast)[this] could be useful
|
@lpsinger I added the examples back; they're still clickable, but I've made it so clicking them copies the example to the clipboard. Would that be useful, or would it be better to make them unclickable? |
There was a problem hiding this comment.
This is a nice touch, but if you want to support copying the text to the clipboard, please reuse the existing components and look-and-feel that we have for that:
This is a block-level component. If you need an inline component, there is https://github.com/nasa-gcn/gcn.nasa.gov/blob/main/app/components/CopyableCode.tsx, although it doesn't have the tooltip status. (@dakota002, if Tyler decides to use that, please refactor CopyableCode and Highlight so that they both consistently use the nice tooltip you added. If not, let's delete CopyableCode, because it is unused.)
Note on appearance: it is jarring that the font size and color does not match the existing help text there.
| To narrow the search results, use Lucene search syntax. This allows for | ||
| specifying which circular field to search (submitter, subject, and/or | ||
| body). Further documentation can be found on the{' '} | ||
| <Link className="usa-link" to="/docs/circulars/lucene"> |
| specifying which circular field to search (submitter, subject, and/or | ||
| body). Further documentation can be found on the{' '} | ||
| <Link className="usa-link" to="/docs/circulars/lucene"> | ||
| Lucene Search Syntax Page |
There was a problem hiding this comment.
Poor link text: every link goes to a "page", so "page" is redundant.
| <details> | ||
| <summary>Advanced Search</summary> | ||
|
|
||
| <div> |
Description
This adds a brief explanation of Lucene queries to the Circulars Archive page, hidden behind a feature flag.
Note: This is a simplified version of #2589 that removes the quick action buttons until the proper implementation can be identified.
Related Issue(s)
Tracked by #2288
Testing