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.

[Feature] Algolia: synonym upgrade --> up

See original GitHub issue

Describe the user story

When searching the Yarn 2 documentation for “upgrade”, the results should include yarn up (CLI).

Describe the solution you’d like

Add a one-way synonym (upgrade --> up) via the Algolia dashboard or API.

Doing so via the API seems best, as a script could be created that handles this. It could only be run by those with access to the “admin API key”, but it could still live inside this repo and serve as a reference as to what Algolia modifications exist, so they’re not hidden away where few can see them.

Describe the drawbacks of your solution

The only drawback I’m aware of is the bottleneck of this change needing to be done by someone with access to the Algolia dashboard, or with access to the “admin API key” (presumably the API key published in this repo is the “search-only API key”).

Oh, and adding a synonym could create a future maintenance burden, particularly if it’s not documented somehow within this repo. Though for all I know, there are already Algolia modifications that aren’t visible to most contributors / consumers of Yarn.

Describe alternatives you’ve considered

I’m not aware of an alternative, but I haven’t bothered digging too much into Algolia or the way it’s being used by Gatsby / React in the webapp that powers the documentation site, I stopped after finding what appeared to be the most elegant solution.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:10 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
Haroenvcommented, Oct 12, 2021

I haven’t checked recently, but shouldn’t it show up as it’s a title @mrienstra ?

1reaction
mrienstracommented, Oct 12, 2021

~I just checked https://yarnpkg.com/ & this has been fixed, not sure how, it wasn’t via algolia/docsearch-configs/configs/yarnpkg_next.json. Just out of curiosity, do you know what changed @Haroenv?~ Edit: Whoops, my bad, see below. I forgot the issue was “upgrade” not showing “up”, I instead entered “up” in the search, here’s the screenshot of that: https://user-images.githubusercontent.com/669326/136838764-7363157d-da61-4bde-bfcd-cfefb8491a22.png

Read more comments on GitHub >

github_iconTop Results From Across the Web

Adding synonyms | Algolia
The Dynamic Synonym Suggestions feature automates synonym generation based on your users' behavior. Algolia's AI identifies any queries your ...
Read more >
Managing synonyms from the dashboard - Algolia
To add, delete, or edit synonyms in the Algolia dashboard: Go to the Search page in Algolia's Dashboard. Select your index.
Read more >
Dynamic Synonym Suggestions - Algolia
The Dynamic Synonym Suggestions feature automates this process for you. Using AI, Algolia identifies queries your users often change and ...
Read more >
Synonyms API methods - Algolia
List of methods to manage synonyms, to create a larger search vocabulary. ... Create or update a single synonym on an index.
Read more >
Alternative correction synonyms - Algolia
Use alternative corrections when you want records with an exact query match to rank higher than a synonym match. For example, consider the...
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