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

Add new results landing page for website search #7942

Merged
merged 6 commits into from
Aug 15, 2024

Conversation

zelinh
Copy link
Member

@zelinh zelinh commented Aug 7, 2024

Description

Add new results landing page for website search for documentation website.
This will be a separate search results page besides than the current dropdown menu.
The page will have options to do advanced search such as version selector and documentation-only search.
The backend API support is pending and will be onboarded pretty soon.

Issues Resolved

Part of these community request. opensearch-project/project-website-search#43 (comment)
Part of opensearch-project/project-website-search#65

Version

All versions will be backported.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Aug 7, 2024

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@zelinh zelinh force-pushed the create-new-webpage branch from cdcb90a to 52d59d3 Compare August 7, 2024 22:17
@epugh
Copy link
Collaborator

epugh commented Aug 9, 2024

cc @smacrakis

@peterzhuamazon
Copy link
Member

Hi @zelinh

A few observations:

  • Add more space between each result in details page, or at least add a horizontal line to separate them
  • Make title of each entry bold text?
  • The simple search drop down list have each entry started with its category, such as News OpenSearch 2.16 while the details page does not.

Thanks.

@peterzhuamazon
Copy link
Member

A few more nitpik for this:

  1. When switching versions from 2.x to 1.3, search bar text does not carry-over.
  2. When switching to 1.3 versions I can still find 2.16 related news.
  3. Change the checkbox of the category to radio button to indicate it is single-select only.

@kolchfa-aws
Copy link
Collaborator

kolchfa-aws commented Aug 13, 2024

Thank you, @zelinh!

In terms of UI, I would change the following:

  • Refine Your Search -> Filter results
  • Remove “Category:” heading
  • Tab over the 2nd and 3rd checkboxes so All becomes parent and Documentation and News become children. Functionally, checking All checks Documentation and News. As soon as one of them is unchecked, All becomes unchecked.
  • Remove the “Start searching” button. Instead, listen to checking and unchecking of the checkboxes and update the results accordingly.
  • Change the placeholder text “Search from results page” to just the magnifying glass icon.
  • Search Results for “…” -> Search results for “…”
  • Augment the results with the category (For example, if you search for A, the results can be A API | Documentation or How to use A | News

Functionality nice-to-haves:

  • Add the number of results in parentheses, after the checkbox so it looks like
    [] All (5)
    [] Documentation (3)
    [] News (2)
  • Add a sort dropdown so users can sort by relevance or date
  • Paginate search results

@zelinh
Copy link
Member Author

zelinh commented Aug 13, 2024

Updated the PR to accommodate the suggestions:

  • Add breadcrumb to the search results and bold the results title.
  • Add break line between results.
  • Remove the Start Searching button and trigger search event based on Enter press in input box or checkbox change.
  • Enable checkbox hierarchy; checking All will check all children checkboxes.
  • Update wording and title.
  • Add magnifying glass to the input field.

@peterzhuamazon @kolchfa-aws Please help take a look here. Thanks.

@zelinh zelinh force-pushed the create-new-webpage branch from 5a8057b to 85f3713 Compare August 13, 2024 23:48
@peterzhuamazon
Copy link
Member

Updated the PR to accommodate the suggestions:

* Add breadcrumb to the search results and bold the results title.

* Add break line between results.

* Remove the `Start Searching` button and trigger search event based on `Enter` press in input box or checkbox change.

* Enable checkbox hierarchy; checking `All` will check all children checkboxes.

* Update wording and title.

* Add magnifying glass to the input field.

@peterzhuamazon @kolchfa-aws Please help take a look here. Thanks.

Looks better now. Still miss radiobutton.

@kolchfa-aws
Copy link
Collaborator

I think a checkbox group works better because radio buttons mean exclusive OR. Checkboxes imply regular OR (users can check one or more checkboxes).

@kolchfa-aws
Copy link
Collaborator

kolchfa-aws commented Aug 14, 2024

@zelinh Thanks for updating! A couple of things:

  • Change the exclamation point to a period at the end of "No results found!" -> No results found.
  • I think when everything is unchecked the results should say "No results found."
  • Move the child checkboxes to the right a little so All is clearly the parent

Screenshot 2024-08-14 at 12 55 48 PM

Thanks!

@zelinh
Copy link
Member Author

zelinh commented Aug 14, 2024

@zelinh Thanks for updating! A couple of things:

  • Change the exclamation point to a period at the end of "No results found!" -> No results found.
  • I think when everything is unchecked the results should say "No results found."
  • Move the child checkboxes to the right a little so All is clearly the parent

Screenshot 2024-08-14 at 12 55 48 PM

Thanks!

Updated with new commits. Please help review again. Thanks!

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you, @zelinh!

Copy link
Member

@peterzhuamazon peterzhuamazon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @zelinh !

@kolchfa-aws kolchfa-aws merged commit 9b8c68d into opensearch-project:main Aug 15, 2024
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website

Signed-off-by: Zelin Hao <[email protected]>

* Update some features

Signed-off-by: Zelin Hao <[email protected]>

* Update the margin between search results

Signed-off-by: Zelin Hao <[email protected]>

* Update display when no checkbox selected

Signed-off-by: Zelin Hao <[email protected]>

---------

Signed-off-by: Zelin Hao <[email protected]>
(cherry picked from commit 9b8c68d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website

Signed-off-by: Zelin Hao <[email protected]>

* Update some features

Signed-off-by: Zelin Hao <[email protected]>

* Update the margin between search results

Signed-off-by: Zelin Hao <[email protected]>

* Update display when no checkbox selected

Signed-off-by: Zelin Hao <[email protected]>

---------

Signed-off-by: Zelin Hao <[email protected]>
(cherry picked from commit 9b8c68d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@zelinh zelinh deleted the create-new-webpage branch August 15, 2024 21:38
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Aug 15, 2024
* Add new results landing page for website



* Update some features



* Update the margin between search results



* Update display when no checkbox selected



---------


(cherry picked from commit 9b8c68d)

Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 backport 2.7 PR: Backport label for 2.7 backport 2.8 PR: Backport label for 2.8 backport 2.9 PR: Backport label for 2.9 backport 2.10 PR: Backport label for 2.10 backport 2.11 PR: Backport label for 2.11 backport 2.12 PR: Backport label for 2.12 backport 2.13 PR: Backport label for 2.13 backport 2.14 PR: Backport label for 2.14 backport 2.15 backport 2.16
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants