documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Add Documentation for Installation and running of Meilisearch on Windows using WSL

Open shivaylamba opened this issue 1 year ago • 5 comments

The current documentation lists only Docker support for installing and running Meilisearch on Windows. WSL has become a very useful alternative to Docker and a number of users have requested for the addition of WSL in the documentation as an alternative to Docker. So we should add documentation for Installation/ Running of Meilisearch on Windows using WSL.

shivaylamba avatar Jul 12 '22 16:07 shivaylamba

Hello @shivaylamba

Currently, Docker is not the only solution suggested for people using Windows, see the Windows tab in this section By curiosity, do you know why they need to use WSL despite all the other possibilities to run Meilisearch on Windows, especially since we provide a windows binary?

More related to the doc, so not I'm not the expert, but I'm still curious so I ask the question: do you think this is something small enough to be added to this tab, or is it too complex and would need a dedicated guide?

curquiza avatar Jul 12 '22 16:07 curquiza

Hi @curquiza we could just add a small section for an alternative for those who use WSL2. Some users have mentioned that they primarily use WSL2 as their main environment, so instead of a dedicated guide, we could a reference for WSL2 in Windows tab section

shivaylamba avatar Jul 13 '22 09:07 shivaylamba

Hi @shivaylamba and @curquiza

I use WSL2 on my windows 11 machine. Since it's just a way to run Linux on Windows, I don't think we need to do anything extra. Linux users know apt and can easily use apt or curl to install meilisearch. Maybe we might reference it as Shivay suggested, but it might look repetitive to some. In any case, it's a good idea.

Cheers!

oluademola avatar Jul 13 '22 10:07 oluademola

Agree that a dedicated guide would probably be overkill. What do you think about changing this line on the Windows tab:

use the installation script (see "cURL" tab above) if you have installed Cygwin or equivalent

to

use the installation script (see "cURL" tab above) if you have installed Cygwin, WSL, or equivalent

If I understand correctly, most WSL users should be experienced enough to find their way with little guidance, so by mentioning it briefly we're basically saying "you can use this tool if you have it" without repeating content.

guimachiavelli avatar Jul 18 '22 08:07 guimachiavelli

Yes this makes sense Gui. We can provide a Hyperlink for WSL2

shivaylamba avatar Jul 18 '22 11:07 shivaylamba