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

Add opensearch support to doc.rust-lang.org #24899

Open
jorisgio opened this issue Apr 28, 2015 · 8 comments
Open

Add opensearch support to doc.rust-lang.org #24899

jorisgio opened this issue Apr 28, 2015 · 8 comments
Labels
A-rustdoc-search Area: Rustdoc's search feature C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jorisgio
Copy link

Opensearch is a common API to query search engine. It is for instanced used to add search engines to the firefox search bar and to chrome.

It would be nice if doc.rust-lang.org supported opensearch to enable doc search directly from firefox.

cc @steveklabnik

@ghost
Copy link

ghost commented Apr 28, 2015

Unfortunately, search for doc.rust-lang.org is performed client-side using a precompiled index so this would require a dedicated Web service, which is a non-trivial complication infrastructure wise.

There are some search-as-a-service products that may have a high free quota and tolerable pricing above it, and those could be used as an alternative.

@jorisgio
Copy link
Author

I see. It probably doesn't worth the trouble then.

@ghost
Copy link

ghost commented Apr 28, 2015

Well, this could just as well be a simple Heroku app that implements http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1 using http://doc.rust-lang.org/search-index.js from the rust nightly. It's doable.

@steveklabnik
Copy link
Member

Heroku's free tier is going to basically be inappropriate with their next pricing adjustment.

@jorisgio , I agree this would be cool, but I doubt that we're going to tackle this any time soon.

@steveklabnik steveklabnik added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Apr 28, 2015
@sanpii
Copy link

sanpii commented Jun 27, 2016

Server side search works now: https://doc.rust-lang.org/std/?search=string

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@steveklabnik
Copy link
Member

Triage: no comments in over two years. @rust-lang/rustdoc is this something we're interested in pursuing?

@GuillaumeGomez
Copy link
Member

I'm not sure we'd want this: it only works on firefox and would require to have a full infrastructure behind to power it.

@jsha
Copy link
Contributor

jsha commented Jun 3, 2021

I think the underlying desire here is that browsers should automatically figure out that doc.rust-lang.org has a search engine, and when you start typing "doc.." they should suggest "Search Rust documentation." I think that's feasible without running a whole backend search engine, but it would require some tweaks to how we do things, which I talk about here: #84214 (comment)

I think the main tweak would have to be that doc.rust-lang.org would have to stop being a redirect to a different domain, and it would need to have a search box prominently featured. I think those would be good changes.

@ehuss ehuss removed the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label Jan 18, 2022
@workingjubilee workingjubilee added the A-rustdoc-search Area: Rustdoc's search feature label Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-search Area: Rustdoc's search feature C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

7 participants