-
Notifications
You must be signed in to change notification settings - Fork 4
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 search capability #89
Conversation
Currently, PageFind is all configured. The Makefile has been adapted to index pages after their generation (PageFind indexes HTML files). This works well with the Left to do:
Questions to answer:
Two examples of search capabilities with PageFind:
|
For the moment, the current prototype uses the CSS and JS of the same feature on the CDS website. They have been slightly adapted, but they should be completely adapted to the desired features and style of the IVOA website. Anyway, the search capability is fully working here. You can already test it if you want, although it may be even more interesting while we will have the newsletters (which contain a lot of content). Currently, the search capability is only available on a single dedicated page ( |
I have not yet adapted the CI, so you will have to test this feature on your local repository ; it does not work yet on To do that locally on your machine, you will have to:
Only running the Hugo command is no more enough if you want to use the search capability. |
This looks great! Is this ready to be merged? Or do you have more changes planned? I'm starting to think the version sites are problemmatic to fully support. If this update would work on main, then I am okay merging it even if it doesn't function on the version/branch site. |
As I said, it is not yet ready to be merged. I still have few style things to do, and tuning of the search engine. And, we also have to decide
|
I checked out and tried the solution on my laptop and it worked seamlessly (even before I realised it had finished). My preference: nice to have, dialog-wise, as a "lens" at the right end of the nav-bar. |
My apologies, I see this is marked as draft. |
I have no problem to defer most of these questions until a later update in order to just get the search functionality enabled and working on the site first; I don't think we need to make all of those decisions now. From my perspective, you can do whatever you think is best for the initial implementation and then we can go from there. CDS website search functionality looks nice to me, personally, so I would have no issue if you just copied that for this PR. My only preference is that we have a box that says "Search" in a prominent place, mainly for accessibility purposes. |
for preview and page generation
The search feature already works. The current layout, styles and JS are a quickly adapted version of the CDS search feature. The style should be adapted to the IVOA. Questions left to answer: - Are images necessary here? - Do we need tags and dates being visible? - Should this search feature be available as a modal on all pages?
…ically generated by Hugo should not be inspected.
7508265
to
1c89474
Compare
and of the text before the search input element.
PageFind binary file should be cached in GitHub.
in order to speed up the upload on the server
Here is a first version of the search module in the IVOA website. It has room for improvement in future PullRequests in function of desired additional features:
The CI has been updated in order to install PageFind (if not already installed or in the cache of GitHub) and to generate the index with PageFind. The preview version is now fully operational ; you can search on the search page. |
I have also done two other unrelated things in this PullRequest:
Now, I consider this PullRequest as ready for review and merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated my branch locally and tested with the make preview.
Looks perfect to me.
Approved.
Absolutely fantastic @gmantele! :) I tested as well using |
This PR aims to add an indexing capability using PageFile and then to add somewhere in the IVOA pages the search form and results.
Fixes #88