Navigation Menu

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

Instant Search Improvements #606

Open
theoryshaw opened this issue Jun 15, 2018 · 4 comments
Open

Instant Search Improvements #606

theoryshaw opened this issue Jun 15, 2018 · 4 comments

Comments

@theoryshaw
Copy link
Contributor

Love the search function, but would be awesome if you could sort by date too.

@mkiser
Copy link
Owner

mkiser commented Jun 15, 2018

I would like this too (as well as being about to take advantage of Algolia's faceted searches) and text, date, title, and h1/title tags are currently indexed.

The current implementation is super basic. But I need to bump up to the latest version of Instant Search for general performance improvements.

I would love help on this because I don't know when I'll ever get around to it.

@mkiser
Copy link
Owner

mkiser commented Jun 15, 2018

Main bits of the Algolia implementation are in the default template:

<!-- ALGOLIA -->

And in the Algolia js in the footer: https://github.com/mkiser/WTFJHT/blob/master/_includes/algolia.html

Read-only API key is available in the config.yml file, so anybody that wants to try this out has everything they need

@theoryshaw
Copy link
Contributor Author

Ever use https://www.bountysource.com/?

Might be a good way to run a mini funding campaign to fund the development of this functionality.

I've used it before, it's a pretty neat approach.

@mkiser mkiser changed the title Search: sort by date Instant Search Improvements Jul 19, 2018
@mkiser
Copy link
Owner

mkiser commented Jul 20, 2018

INSTANT SEARCH REQUIREMENTS

WTF is a blog built on Jekyll using Algolia for its search engine. We need to migrate to Algolia's Instant Search toolkit: https://community.algolia.com/jekyll-algolia/blog.html

User Stories

  • As a reader, I want the WTFJHT Algolia Instant Search integration to be a powerful discovery tool and resource for exploring the history of the Trump administration
  • As a reader, I want to be able to search for all records related to a person, place, or thing. By default, the results should be limited to the first 10 results, but allow the user to "show more"
  • As a reader, I want to be able to use common synonyms for searching (e.g. Russia matches Moscow, Kremlin)
  • As a reader, I want to be able to filter search results by preset date ranges (e.g. "All Time"; "Past Week"; "Past Month"; "Past Year"; "Custom Range")
  • As a reader, I want to be able to use and|or operators
  • As a reader, I want to be able to share SEO friendly URLs from my search parameters

WTF Reqs

  • Index only files in the _posts directory
  • Index body contents, title, description, and date
  • Default sort by best match first, then date
  • Update once per day as a separate Travis CI process. Currently, the index is updated on every build, which is wasteful. Proposal: Update the index on first deploy per day (checking against the previous post's date)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants