terraform-website
terraform-website copied to clipboard
hashicorp
Terraform Registry: OpenSearch support
As a frequent user of the Terraform registry search, I really would appreciate if it would provide OpenSearch support, so I can search e.g. from Firefox search bar, and add it to my saved search engines.
Technically it is very easy, just publish an OpenSearch description file, see here. And enable autodiscovery of that by adding a link to the registry file, see this example.
I would do the PR myself, but I'm not quite clear on how to retrieve the SearchUrl, since it is hidden somewhere behind Ember/Algolia magic. Maybe you could drop a hint on how that works :smiley:
Hi @oliverboehme Thank you for your suggestion! I'm going to let @jescalan weigh in here - he's one of the awesome folks who helps build and maintain our website and all of its functionality. Jeff - what are your thoughts on this?
Hi @oliverboehme, my name is Manuel and I sit on the team that owns the public registry. I spent a bit of time looking into this. Unfortunately, there isn't a standalone page like registry.terrform.io/search?q=foo that a search plugin could use. We don't have adding such a page on our roadmap. However, there are individual pages for searching providers and modules separately: https://registry.terraform.io/search/providers?q=aws and https://registry.terraform.io/search/modules?q=vpc. I think it would be possible to add an OpenSearch file to this repository that references those URLs, which would accomplish some of what you want.
If you'd like to take a pass at such a PR, we'd be happy to take a look.
After having a look at the terraform-website code, I assume this is not the right repo.
The opensearch.xml would need to reside at https://registry.terraform.io/opensearch.xml, also the <link> belongs to the landing page of the registry.
But I guess those are private repositories?
Anyway you can have a look at the diff which was working for me locally: https://github.com/hashicorp/terraform-website/compare/master...oliverboehme:feature/1832-open-search-support
@mwudka What are your thoughts on this? Thank you @oliverboehme for working on this!
Hello! Quick update on this :-) I forwarded this along to engineering and it is now in the backlog. We need to do some investigation on the backend to get this added in properly. I'm going to mark this ticket as "On Hold" for now until engineering can address it, but I wanted you to know we've had some conversations offline about it and we will provide updates when available!
We are working to archive this repo and will be closing this issue now. We are tracking this in our standard pipeline but it has not made it onto our roadmap yet. Please reach out to [email protected] with any further questions.
