Create a documentation of configuration parameter #2477
Description
WHAT
The edc-build has an autodoc plugin which creates a set of documentation extracted from the code. E.g., it shows all defined settings used in certain extensions. This should be the basis for a overall documentation of configuration settings, that are configurable or that must be configured, so that an adoptor understands what he needs to define and where he has a potential to influence the execution by changing default config values.
The idea is, to gather the information and to provide different documentation approaches:
- Adding the rendered information as a webpage, e.g., on Github Pages
- Providing an "executable" env file, which can be merged with a local env file to have a running configuration that allows to start a connector in a dev environment
- Provide delta information about changed settings between versions
WHY
To provide better support for adoptors
HOW
Based on Autodoc with post processing