terraform-website icon indicating copy to clipboard operation
terraform-website copied to clipboard

Have a search facility in the official terraform documentation

Open saurabh-hirani opened this issue 9 years ago • 3 comments

The documentation at https://www.terraform.io/docs/configuration/index.html is great and precise but it should have search capability so that users can look up keywords in the official docs instead of routing their queries via google.

saurabh-hirani avatar Oct 25 '16 13:10 saurabh-hirani

Maybe a community ran wiki to allow commenting and versioning would suffice better for the documentation?

zdxn avatar Oct 25 '16 15:10 zdxn

I'd like to pick up on this one and see if I can get something working over the next couple of weeks or so.

Anything in particular I should look out for here? I'm thinking of implementing some kind of Spotlight-like search box, similar to Ctrl-P/Cmd-P in some text editors.

I've noted that we're already generating a sitemap.xml file—we can do something similar to that to generate an index of page titles that could be loaded in through JavaScript.

jammycakes avatar Mar 22 '17 10:03 jammycakes

@jammycakes that seems to be a good idea.

saurabh-hirani avatar Mar 22 '17 11:03 saurabh-hirani

https://developer.hashicorp.com/ has both navigation filtering and search support. 👍 If there are specific feature requests or bug reports, please raise a new issue.

bflad avatar Mar 14 '23 13:03 bflad