Nomad: Idea for improving documentation: Search

[erhlee-bird]

tl;dr - Across the various Hashicorp products, it would be great to have an easy, empowering search experience for the documentation websites.

I was helping a coworker get up to speed with some Nomad concepts and our Nomad deployment.
He commented that the docs were really great if you knew exactly the nouns and verbs to look for.

This occurred when trying to point my coworker to documentation about the resources stanza.

With my head knowledge, I know that the resources behave differently per task driver (e.g. memory upper-bound for Docker but not exec, cpu rate-limiting only when under system contention, etc). This is not reflected when looking at the documentation for the resources stanza at the specification level.

This might be solved by adding links to improve connectivity and discoverability or filling in more of the documentation. However, I think a means by which to search the documentation inline might be helpful, especially for guiding new users.

---

As an example of a site that provides the kind of experience I'm trying to describe, the documentation for NATS has a great search sidebar (powered by Algolia maybe?) that's very responsive and helps for tying together nuanced concepts from different protocols and tools in their ecosystem.

[tgross]

Hi @erhlee-bird! You'll be excited to hear that we're currently working on a revamp of the documentation sites that will include search. Stay tuned!

[tgross]

Doing some issue cleanup. Shipped in https://github.com/hashicorp/nomad/pull/8592 and improved upon in a couple PRs since then.