[Feature] Algolia: synonym upgrade --> up
See original GitHub issueDescribe 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:
- Created 2 years ago
- Comments:10 (9 by maintainers)

Top Related StackOverflow Question
I haven’t checked recently, but shouldn’t it show up as it’s a title @mrienstra ?
~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