Feature idea: `example` and `docs` fields for validators

[af]

Feature idea: `example` and `docs` fields for validators

[SimenB]

We have defaults for every variable (at least devDefaults), so we have examples from there. What is a reference for?

I agree example is useful if a default isn't provided though!

[af]

Ah yes if you have a default for everything, then an example would not be useful.

The idea with reference is it's a link to documentation or context about the setting (the name of this option could probably be improved!)

[SimenB]

Calling it docs makes more sense then, IMO. I can see the use case for that, even though I don't think we'll use it (OTTOMH). We map some variables that are injected into the docker containers by k8s, might be useful pointing to some docs for that, I suppose.

So yeah, 👍 from me!

[af]

Nice, I like docs better as well. Will try and land this soon