Skip to content

Add documentation for YAML configuration

Stefan Spettel requested to merge yaml_config_documentation into develop

Add YAML configuration documentation.

@arora @tien-thinh.nguyen @kharade @defosseu Please have a look at the description and provide feedback. I will also check everything again in the online editor 😄.

I took the time and actually confirm the behavior as described in this document by checking the code.

This is why I documented it in an as-is fashion. We see that for example in AMF we do not have any validation of the configuration. I suggest we fix this in the code first and then update this file accordingly. Documenting the target state here may be confusing to the user.

One exception to this rule: The location of the conf file points to the master branch, so we do not have to change it for 1.6 release, but if you prefer I can change it to develop for now (These files currently do not exist).

During checking the code, I have found several issues in SMF and AMF, see also the Git issues:

Merge request reports