Eksctl: Site : add search functionality

[bia]

As discussed with @gemagomez this morning, as our documentation grows, it is becoming increasingly valuable to add a search bar to our website.
There are a few different ways to implement this.

@martina-if maybe you have an idea of what the best one to pursue would be.
cc @sbernheim

[martina-if]

I don't have an opinion right now on what would be the best way to do it, I would need to read a bit on what works best with Hugo and Netlify.

[errordeveloper]

I don't see a reason why not just rely on regular search engines, perhaps we should do some search testing on how easy it is to answer eksctl question by using Google and DDG.

[gemagomez]

I don't know, @errordeveloper, I normally use the search engine to get to the website I am trying to search on and then I expect to be able to find items in there through the local search. That's how most technical documentation works.

Some examples:

• https://golang.org/doc/
• readthedocs websites
• https://docs.python.org/3/
• https://kubernetes.io/docs/home/
• etc

[errordeveloper]

That's how most technical documentation works.

Yes, but I am pretty sure in-site search facilities are rarely used, so I consider this low priority and would rather see any general improvements to the docs before this. There are plenty of actionable issues.
We can pull some stats from weave.works on how search is used there in e.g. Weave Net docs.

[gemagomez]

I use them to search through docs and I am sure many other users do. You cannot assume people have your search habits. When a user is new to the project they are trying to do things and they are going to try to crawl the documentation without the need of a search engine. Non searchable docs are rather not user friendly.

[dholbach]

This is resolved with the move to mkdocs, check e.g. https://deploy-preview-2062--eksctl.netlify.app/ - it's just not part of a release yet.