koopjs / koop-provider-marklogic

A Koop Provider that can be used to exposed data in MarkLogic via Esri feature services
https://koopjs.github.io/koop-provider-marklogic/
Other
6 stars 11 forks source link

Improve config setup and documentation #176

Closed jkerr5 closed 1 year ago

jkerr5 commented 3 years ago

The setup of the files in the config folders could be improved.

There should be a default.json that has the default values that we want set. There should also be a file called custom-environment-variables.json that allows parameters like usernames and passwords to be set via environment variables.

The documentation should be improved to indicate how to override the configuration using an environment-specific config file as well as what parameters could be set using actual environment variables.

rjrudin commented 1 year ago

I think this is OBE - there are multiple config files now, and I think the README adequately describes when to use each one and how to customize "default.json".

At least, before we release 2.0, we'll ensure that the README provides coverage of what's supported in a config file.