Go over all OPAL's config variables and add descriptions

[asafc]

Confi (our configuration lib) allows each config var to have a description string. All strings should be well explained and documented.

[money8203]

Want me to handle the project's documentation @asafc ?

[orweis]

@money8203 for sure, we'd appreciate a hand - you can find the relevant files here:

• https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py
• https://github.com/permitio/opal/blob/master/packages/opal-client/opal_client/config.py
• https://github.com/permitio/opal/blob/master/packages/opal-server/opal_server/config.py

[money8203]

So what in specific do I have to add or document ?

[orweis]

As you can see each config value is defined via confi - e.g. calls to confi.model() or confi.bool() Some of these are missing the "description" argument - which should contain human readable text explaining about the configuration value.

Some of these can be deduced from the variable name, some from the comments in the code, and some would require reading the code itself to explain.

[money8203]

#358 I've added some descriptions for this file https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py