question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[docs][workflow] Implementing search with algolia.

See original GitHub issue

Part of the Top 25 Learning Workflows initiative. See #13708 for the meta issue that this issue falls under.

User story

As a new Gatsby user, I would like to learn how to integrate Algolia into my Gatsby site.

Evaluation

Search Discover Complete Linked Tone Style Overall
😄 😄 😄 😐 😐 😄 😄

Steps taken to implement

  1. Searchability i. Searched gatsby algolia on Google; clicked first result.
  2. Discoverability i. Brought me right to the content i’m looking for at docs /adding-search-with-algolia/, thereby having no need to click on anything on .org.
  3. Completeness i. Followed steps to install the gatsby-plugin-algolia and react-instantsearch-dom. [rec] Having the installation steps documented in the plugins page would go a long way as I could get easily intimidated reading up the installation process on the readme of the plugin on github. ii. Followed steps to configure algolia-plugin in gatsby-config.js file. [rec] Making explicit on where to create .env in project would save some research time. [rec] As well as a guide on how to setup env variables on the Netlify dashboard will be significant. iii. Followed steps to adding search interface to site.[rec] Though a new gatsby project works on the assumption that gatsby-transformer-remark plugin has be installed and that the appropriate fields in frontmatter of the markdown files are in place. So an explicit mention of this would go a long way. iv. Success!!
  4. Linkedness i. Links to the dotenv docs on setup process would be very helpful. ii. Links to styled components docs would be useful as well.
  5. Tone i. Sometimes heavy on technical terminology; perhaps not completely understandable to a web development beginner.
  6. Style i. [rec] A header for the section of setting up queries at src/utils/algolia.js would reduce the cognitive load.

Recommendations

  • Completeness: Having the gatsby-plugin-algolia and react-instantsearch-dom installation steps documented in the plugins page would go a long way as I could get easily intimidated reading up the installation process on the readme of the plugin on Github.
  • Completeness: Making explicit on where to create .env in project would save some research time.
  • Completeness: A guide on how to setup env variables on the Netlify dashboard will be significant.
  • Completeness: An explicit mention to install gatsby-transformer-plugin and having the appropriate fields in the frontmatter of the markdown files would go a long way.
  • Style: A header for the section of setting up queries at src/utils/algolia.js would reduce the cognitive load.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:12 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
ehrencronacommented, Jul 28, 2020

I reviewed them again. As far as I can tell all the points under “recommendations” are covered by the changes.

0reactions
marcysuttoncommented, Jul 28, 2020

I think we can close this one, thanks @ehrencrona for your PR!! It was a great addition.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How Algolia works
Algolia's powerful API lets you seamlessly implement search within your websites, mobile, and voice applications. The Algolia search engine powers billions ...
Read more >
Algolia Documentation
Explore guides, code samples, integrations, and API reference documentation for building amazing Search and Discovery experiences with Algolia.
Read more >
Search REST API Reference
The Search REST API is the core of Algolia Search. Around it, Algolia built a complete ecosystem, of libraries, tools, and a dashboard....
Read more >
Search Autocomplete
Algolia is a hosted, API-first platform used to build world-class search & discovery experiences. Start building quickly using libraries for every major ...
Read more >
Algolia Build 101 - Search UI Implementation Introduction
Algolia Build 101 - Search UI Implementation Introduction. Great search experiences are all about the end users. To provide that slick, rewarding experience ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found