search

cockroachdb / docs

CockroachDB user documentation
https://cockroachlabs.com/docs
Creative Commons Attribution 4.0 International
187 stars 455 forks source link

Write simple interface for adding new search synonyms #7994

Open yzdocs opened 4 years ago

yzdocs commented 4 years ago

Exalate commented:

Write new function that allows writers to easily add new search synonyms to a running list. Document results in CONTRIBUTING.md.

Jira Issue: DOC-635

jseldess commented 4 years ago

I asked this in the recent PR with the relevant code, but can you share your thinking on why it's better to use the api vs. the algolia dashboard to add and manage synonyms?

yzdocs commented 4 years ago

Ah, sorry if I misunderstood your comment on the other issue. I think there are two main advantages to using the API:

  1. All Algolia settings and configurations are centralized in our code repo, so everything is in one place and we don't have to spend time tracking down whether something is set up there versus in the UI dashboard.
  2. Having settings as part of our GitHub repo means that there's a paper trail; if something goes wrong we can look at commit history and figure out what to undo.

Meanwhile, the UI dashboard's big advantage is ease of use for writers, which may outweigh the two points above. How about we put this on a meeting agenda and have writers weigh in?

exalate-issue-sync[bot] commented 1 year ago

Nick Vigilante (nickvigilante) commented: I think the simplest interface to add new search synonyms would be to enclose everything related to Algolia in a single config file.