Circulars - Lucene search documentation #2502

tylerbarna · 2024-07-30T20:51:29Z

Description

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

Related Issue(s)

#2288, #2501

Testing

Add CIRCULARS_LUCENE feature flag to .env
Navigate directly to http://localhost:3333/docs/circulars/lucene
Read Documentation
Remove CIRCULARS_LUCENE feature flag from .env
Navigate directly to http://localhost:3333/docs/circulars/lucene
Page should not load

create circulars archive lucene search documentation page

docs can be more extensive

lpsinger

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:

tylerbarna · 2024-08-01T16:47:16Z

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:

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

tylerbarna · 2024-08-01T16:48:23Z

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 · 2024-09-05T19:02:23Z

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 6.08%. Comparing base (cfd0c49) to head (7816af5).
Report is 69 commits behind head on main.

Files with missing lines	Patch %	Lines
app/routes/docs.tsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##            main   #2502      +/-   ##
========================================
+ Coverage   5.26%   6.08%   +0.82%     
========================================
  Files        158     164       +6     
  Lines       3912    4073     +161     
  Branches     419     450      +31     
========================================
+ Hits         206     248      +42     
- Misses      3705    3823     +118     
- Partials       1       2       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lpsinger

This looks great, but can we title the page "Advanced Search"?

app/routes/docs.circulars.lucene.mdx

Co-authored-by: Leo Singer <leo.p.singer@nasa.gov>

lpsinger

Make "Swift" title case instead of all caps.
Add a hyperlink to this page from the side nav.

Bumps [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) from 7.25.3 to 7.25.4. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.25.4/packages/babel-preset-env) --- updated-dependencies: - dependency-name: "@babel/preset-env" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Puts test message behind a captcha (nasa-gcn#2547) Prefer deduplication when installing packages This decreases the chances of obscure TypeScript errors due to having multiple versions of the same package in the tree. Fix broken Circulars hyperlinks by pinning Remix version Pin Remix version to 2.10.3 to fix broken Circulars cross-reference hyperlinks. Fixes nasa-gcn#2563. Add direct dependency on esbuild We had an inderect dependency on esbuild because Remix depends on it, but we should have a direct dev dependency as well because our own build system calls esbuild itself. Always send new versions of GCN Circulars over Kafka See nasa-gcn#2562. Updates the change request functions to automatically close the corresponding zendesk ticket (nasa-gcn#2546) Bump lint-staged from 15.2.8 to 15.2.10 Bumps [lint-staged](https://github.com/lint-staged/lint-staged) from 15.2.8 to 15.2.10. - [Release notes](https://github.com/lint-staged/lint-staged/releases) - [Changelog](https://github.com/lint-staged/lint-staged/blob/master/CHANGELOG.md) - [Commits](lint-staged/lint-staged@v15.2.8...v15.2.10) --- updated-dependencies: - dependency-name: lint-staged dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Adds option to redistribute email for circulars (nasa-gcn#2569) Resolves nasa-gcn#2562. Bump husky from 9.1.4 to 9.1.6 Bumps [husky](https://github.com/typicode/husky) from 9.1.4 to 9.1.6. - [Release notes](https://github.com/typicode/husky/releases) - [Commits](typicode/husky@v9.1.4...v9.1.6) --- updated-dependencies: - dependency-name: husky dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Bump @types/node from 22.5.0 to 22.5.5 Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.5.0 to 22.5.5. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Bump vite Bumps and [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite). These dependencies needed to be updated together. Updates `vite` from 5.4.3 to 5.4.6 - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v5.4.6/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v5.4.6/packages/vite) Updates `vite` from 4.5.3 to 5.4.6 - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v5.4.6/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v5.4.6/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-type: indirect - dependency-name: vite dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> clarify conditions for when most_probable_direction is present Bump serve-static and express Bumps [serve-static](https://github.com/expressjs/serve-static) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together. Updates `serve-static` from 1.15.0 to 1.16.2 - [Release notes](https://github.com/expressjs/serve-static/releases) - [Changelog](https://github.com/expressjs/serve-static/blob/v1.16.2/HISTORY.md) - [Commits](expressjs/serve-static@v1.15.0...v1.16.2) Updates `express` from 4.19.2 to 4.21.0 - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/4.21.0/History.md) - [Commits](expressjs/express@4.19.2...4.21.0) --- updated-dependencies: - dependency-name: serve-static dependency-type: indirect - dependency-name: express dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Set IceCube notice field names in a code font Updates the change request form to populate with previously requested changes if they exist (nasa-gcn#2585) * Updates the change request form to populate with previously requested changes if they exist * throw all but the 404, types on zendeskticketId * Apply type narrowing * Update function to throw error and just return Id * Update app/lib/zendesk.server.ts Co-authored-by: Leo Singer <leo.p.singer@nasa.gov> * Update app/routes/circulars._archive._index/route.tsx Co-authored-by: Leo Singer <leo.p.singer@nasa.gov> * Add final check for undefined * Prettier on zendesk server --------- Co-authored-by: Leo Singer <leo.p.singer@nasa.gov> Bump rollup Bumps and [rollup](https://github.com/rollup/rollup). These dependencies needed to be updated together. Updates `rollup` from 4.21.2 to 4.22.4 - [Release notes](https://github.com/rollup/rollup/releases) - [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md) - [Commits](rollup/rollup@v4.21.2...v4.22.4) Updates `rollup` from 3.29.4 to 4.22.4 - [Release notes](https://github.com/rollup/rollup/releases) - [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md) - [Commits](rollup/rollup@v4.21.2...v4.22.4) --- updated-dependencies: - dependency-name: rollup dependency-type: indirect - dependency-name: rollup dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Bump @testing-library/react from 16.0.0 to 16.0.1 Bumps [@testing-library/react](https://github.com/testing-library/react-testing-library) from 16.0.0 to 16.0.1. - [Release notes](https://github.com/testing-library/react-testing-library/releases) - [Changelog](https://github.com/testing-library/react-testing-library/blob/main/CHANGELOG.md) - [Commits](testing-library/react-testing-library@v16.0.0...v16.0.1) --- updated-dependencies: - dependency-name: "@testing-library/react" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Moves the definition of the send function to resolve issues with kafka related imports in the remix build (nasa-gcn#2590) Fixes nasa-gcn#2588. correct typo Bump typescript from 5.5.4 to 5.6.2 Bumps [typescript](https://github.com/microsoft/TypeScript) from 5.5.4 to 5.6.2. - [Release notes](https://github.com/microsoft/TypeScript/releases) - [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release.yml) - [Commits](microsoft/TypeScript@v5.5.4...v5.6.2) --- updated-dependencies: - dependency-name: typescript dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Bump eslint from 8.56.0 to 8.57.1 Bumps [eslint](https://github.com/eslint/eslint) from 8.56.0 to 8.57.1. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](eslint/eslint@v8.56.0...v8.57.1) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> update burstcube status remove unused import Bump @types/color-convert from 2.0.1 to 2.0.4 Bumps [@types/color-convert](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/color-convert) from 2.0.1 to 2.0.4. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/color-convert) --- updated-dependencies: - dependency-name: "@types/color-convert" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Circulars - Lucene search documentation (nasa-gcn#2502) Add lvk notice unique ID documentation Bump @playwright/test from 1.46.1 to 1.48.0 Bumps [@playwright/test](https://github.com/microsoft/playwright) from 1.46.1 to 1.48.0. - [Release notes](https://github.com/microsoft/playwright/releases) - [Commits](microsoft/playwright@v1.46.1...v1.48.0) --- updated-dependencies: - dependency-name: "@playwright/test" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> draft news items fixed news anchor adds synonyms moderation front end (nasa-gcn#2538) Resolves nasa-gcn#2116. adding synonym moderation link to circulars index page Adds fermi gbm to json quickstart behind feature flag Adds other alerts from feedback Updates schema docs to clarify unevaluatedProperties use Revise the docs for schema new producer template Bump @xmldom/xmldom from 0.8.10 to 0.9.4 Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.8.10 to 0.9.4. - [Release notes](https://github.com/xmldom/xmldom/releases) - [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md) - [Commits](xmldom/xmldom@0.8.10...0.9.4) --- updated-dependencies: - dependency-name: "@xmldom/xmldom" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Fix link for EP example alert JSON SVOM Mission Page Update app/routes/missions.svom/route.mdx Co-authored-by: Leo Singer <leo.p.singer@nasa.gov>

tylerbarna added 2 commits July 30, 2024 15:33

initial commit

4962663

create circulars archive lucene search documentation page

basic lucene query docs

f3b352d

docs can be more extensive

lpsinger requested changes Aug 1, 2024

View reviewed changes

tylerbarna added 2 commits September 3, 2024 13:27

expand lucene documentation

3ebd55a

fix prettier

d8f5ae5

tylerbarna requested a review from lpsinger September 16, 2024 17:24

dakota002 assigned tylerbarna Sep 23, 2024

lpsinger requested changes Sep 30, 2024

View reviewed changes

app/routes/docs.circulars.lucene.mdx Outdated Show resolved Hide resolved

app/routes/docs.circulars.lucene.mdx Outdated Show resolved Hide resolved

tylerbarna and others added 3 commits October 7, 2024 11:12

Update app/routes/docs.circulars.lucene.mdx

e504b1d

Co-authored-by: Leo Singer <leo.p.singer@nasa.gov>

Update app/routes/docs.circulars.lucene.mdx

8f0f73e

Co-authored-by: Leo Singer <leo.p.singer@nasa.gov>

rename advanced search

0915574

tylerbarna requested a review from lpsinger October 7, 2024 17:04

lpsinger requested changes Oct 8, 2024

View reviewed changes

address requested changes

7816af5

tylerbarna requested a review from lpsinger October 8, 2024 21:00

lpsinger approved these changes Oct 9, 2024

View reviewed changes

lpsinger merged commit 0fa60e5 into nasa-gcn:main Oct 9, 2024
12 checks passed

tylerbarna deleted the circulars-lucene-search-documentation branch October 9, 2024 16:01

Vidushi-GitHub pushed a commit to Vidushi-GitHub/gcn.nasa.gov that referenced this pull request Oct 13, 2024

Circulars - Lucene search documentation (nasa-gcn#2502)

7dbd7c1

Vidushi-GitHub pushed a commit to Vidushi-GitHub/gcn.nasa.gov that referenced this pull request Oct 13, 2024

Circulars - Lucene search documentation (nasa-gcn#2502)

716f6a0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Circulars - Lucene search documentation #2502

Circulars - Lucene search documentation #2502

tylerbarna commented Jul 30, 2024

lpsinger left a comment

tylerbarna commented Aug 1, 2024

tylerbarna commented Aug 1, 2024

codecov bot commented Sep 5, 2024 •

edited

Loading

lpsinger left a comment

lpsinger left a comment •

edited

Loading

Circulars - Lucene search documentation #2502

Circulars - Lucene search documentation #2502

Conversation

tylerbarna commented Jul 30, 2024

Description

Related Issue(s)

Testing

lpsinger left a comment

Choose a reason for hiding this comment

tylerbarna commented Aug 1, 2024

tylerbarna commented Aug 1, 2024

codecov bot commented Sep 5, 2024 • edited Loading

Codecov Report

lpsinger left a comment

Choose a reason for hiding this comment

lpsinger left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Sep 5, 2024 •

edited

Loading

lpsinger left a comment •

edited

Loading