Documenting Changes in Configuration Files

When any changes are introduced to config files (such as new options or parameters), include them at the end of the Resolved Issues file of the Release notes. When describing the change, include links to:

• The config file that was changed, in GitHub, if available
• The documentation page that describes the config file

Put the changes at the end of the Resolved Issues file, with the following information:

• Service or component
• Configuration file
• Description of the change
• Default values, if any

Include a note stating whether the modifications introduced to config files require users to manually modify their files.

Here's a full example:

Since version 6.10.3 the following changes apply to OpenNebula services configuration files:

Note: The following attributes are not included in the configuration files distributed with 6.10.3. If you wish to use these attributes, add them manually to the corresponding file.

FireEdge Service

Config file	Description	Action	Values
vm-template-tab.yaml	New attribute: dialogs.instantiate_dialog.pci	Sets the PCI tab when instantiating a VM	tue,false

Please note that you do not need to modify your configuration files unless you wish to change the service's behavior.

Back to top