More guides/usage examples

[poiug07]

Hi, I am quite new to Zoekt, but it has been a very useful tool for me. I use a self-hosted Git server so cannot use GitHub indexing samples, so it took me quite some time to start running, but I know my setup is not an optimal one.

I made a docker container to index the directory. Later I serve indexes with another docker container. However, I noticed there are quite a good number of commands that might be useful in my case, like zoekt-git-index, zoekt-dynamic-indexserver, zoekt-merge-index. However, I couldn't find samples of how to use them and more explanation on the behaviour of those commands.

Is there anyone working on it currently? If not, I can start but I will need some help. It will be useful for people wanting to use Zoekt, to have a guide or more informative doc.

[stefanhengl]

Thanks for reaching out! I agree, we should improve the documentation. We are planning to do this soon-ish. I cannot promise a specific date, but this has been on our radar for a while.

[jtibshirani]

@poiug07 I opened https://github.com/sourcegraph/zoekt/pull/905 with some more background and usage examples. Apologies for the delay! Let us know if you have specific questions not covered there.

[poiug07]

@jtibshirani Thank you, that is a great improvement and covers many use cases.

However, I couldn't find the answer to my main question. I want to know how to index multiple local git repos and merge those indices. The last time I tried doing it newer index overrode the older one. My current workaround is to treat the root directory containing my git repos and index it as a whole. I read the source in cmd directory and saw several commands that could be used, but never got to try them myself. I guess some of them are obsolete but it is hard to judge without some high-level description (a bit longer than comments in the header of files).