Ideas to improve YAML files consistency

[marcusburghardt]

This discussion was created to collect ideas on how we could update the Project Style Guide regarding YAML files format.

The point was raised by @dodys when reviewing #13646 .
This PR ensured all control files were aligned with the current YAML format defined in the Project Style Guide

In parallel it was also included a CI Test to check the YAML format of control files and profiles files whenever these files are changed in a PR. In addition to this test it was also introduced a documentation to help maintainers to properly format these YAML files in alignment to Project Style Guide

At this point we have rules defined in the Project Style Guide, we have CI tests to ensure format consistency, and we have documentation to help contributors to easily fix formats.

Considering the project relies heavily in YAML files, it would be great if we could review our current YAML rules, collect ideas, discuss impact, and polish our YAML rules so we can configure the automation tools, gradually update our YAML files to keep them as consistent as possible, and ensure consistency in the long-term through CI tests.

Maybe a good starting point would to review our current rules in Project Style Guide and the YAML files in the project to assess what is good and what could be improved.

Thanks

[Mab879]

If want consistency I would reformat like #13646 then remove the "Existing YAML files may use 2-space indentation" exception. I would also then add "Must formatted to pass yamllint using the project configuration" to the YAML section.

I don't think I would change anything about the current rules in .yamllint.

[dodys]

My main point from the PR was not only about consistency, but not taking such changes lightly and bring it up to attention to all maintainers before merging anything. The fact that PR #13606 was merged without some other maintainers doesn't help, as many might have their own downstream branches and those changes only create noise.

[AlexXuan233]

I think if any updated yaml file can use yamlfix with config to format file before create PR, it should be good.

Another suggestion about yaml file format, i think we can suggest using Literal Style with chomping indicator |- for multiple line string, avoid multiple line string like this , not using a lot of \.