Add documentation for all the config options

[salemhilal]

config-example.json is pretty through, but being that it is a json file, it's hard to be verbose or descriptive. Add a /docs/config-options.md (or something similar) and document each of the config options.

Things that need documentation:

• max-concurrent-indexers
• dbpath
• title
• health-check-uri
• vs-config
• repos
• git config options
• hg config options
• svn config options

[ehrktia]

@salemhilal , @dschott68 @jacobrose @nickmoorman i would like to volunteer for this topic.
Already have a branch locally with below content in docs/config-options.md

ConfigOption	Description
MaxConcurrentIndexers	defines the total number of indexers required to be used for indexing code. If not provided defaults 2
HealthCheckURI	health check url for hound , if not provided defaults to /healthz
DbPath	absolute file path where the config.json file exists. By default is data
title	Title used for the application.Defaulted to 'Hound'
url-pattern	composed of base url and anchor values in form of key value pairs.
vs-config	holds the version control config, default VCS used in Hound is git.Other options for VCS are svn,mercurial,bitbucket,hg, etc.Refer to config-example.json to get the list of vcs and usage
Repos	holds the list of repos which are required to be indexed by Hound . Each Repo is added with reponame as a Json Key with options associated with repo as values similar to example provided in config-example.json

gitOptions	Description
ms-between-polls	time interval to poll the repo url ,default is 30s
detect-ref	used to determine branch , defaults to master branch
ref	used to provide reference for the branch for repo.

svn-options	Descriptions
username	user name for the svn repo
password	password to authenticate use for svn repo.

url-options	Description
url-pattern	when provided used by Hound for config, else defaults to {url}/blob/{rev}/{path}{anchor}
anchor	when provided used for vcs config else set to #L{line}

[jacobrose]

@ehrktia Sounds great -- would you please submit a pull request? Thank you very much for volunteering!

[p3732]

I think it would also be helpful to add the unit for ms-between-polls (I assume it is milliseconds because of the name, which seems excessive, but I don't know).

[StingyJack]

Also any advice regarding theoretical or practical limitations (does it make sense to have 200 indexers, for example) would be nice

[salemhilal]

Hey, I'm gonna close this issue out, but if there are outstanding issues, I can re-open it.
@StingyJack, to answer your question, I think the indexer count would depend on the system, so a bit of test-and-time might be the best approach. I'd recommend using an indexer per available core on your machine to start.