Skip to content

Add a detailed configuration file explanation

Adam Coldrick requested to merge sotk/documentation/config-explainer into master

Before raising this MR, consider whether the following are required, and complete if so:

  • Unit tests
  • Metrics
  • Documentation update(s)

If not required, please explain in brief why not.

Description

The docs don't currently do a very good job of explaining the configuration file layout. This MR adds a section to the docs which walks through a simple config file piece-by-piece explaining how each part is used and interpreted.

Merge request reports