Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 494: Provide a link to a wiki page on Github regarding search help. #510

Merged
merged 5 commits into from
Jan 20, 2023

Conversation

kaladay
Copy link
Contributor

@kaladay kaladay commented Jan 18, 2023

Description

Opted to use an icon to fit in with the current available space.

The URL is exposed via the new URLs appConfig setting:

  • searchHelpManageUrl
  • searchHelpDismaxAndUrl
  • searchHelpDismaxOrUrl
  • searchHelpEdismaxAndUrl
  • searchHelpEdismaxOrUrl
  • searchHelpLuceneAndUrl
  • searchHelpLuceneOrUrl

The help only appears on the non-everything searches in the Discovery View pages.

In the management of Discovery View, a help link is added as a sentence at the bottom of each modal.

The changes on the github wiki are to be updated separately.

Fixes #494

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Manually.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

…elp.

Opted to use an icon to fit in with the current available space.

The URL is exposed via the new `searchHelpUrl` appConfig setting.
@kaladay kaladay requested review from jcreel, jeremythuff, a user and rmathew1011 January 18, 2023 20:35
@coveralls
Copy link

coveralls commented Jan 18, 2023

Coverage Status

Coverage: 45.337% (+0.09%) from 45.242% when pulling 225c306 on 494-document_search into 1b696f3 on staging.

…lecting searching algorithms.

We are using the Github Wiki which lacks most of the structural functionality that would allow for the code here to be simpler.
Ideally, something like "id" tags can be used on a single page to only need a single link.
This is not possible with the current Github Wiki functionality.

This solution, which is far from ideal, uses a separate URL for each of the combinations between the Parser and the Operands.

Text with a link is provided on the management page because landscape is readily available.
@kaladay kaladay merged commit 3cbbaec into staging Jan 20, 2023
@kaladay kaladay deleted the 494-document_search branch January 27, 2023 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants