Docs: document indentation for version history notes
Problem to solve
Document indentation for version history notes.
Further details
We don't say how to indent version history notes, but I'm pretty sure we have a linter for this.
The major problem is that the linter doesn't say what's wrong with my changes' syntax (#273770 (closed)). As the style guide doesn't say anything about indentation for version history notes, we kind of need to guess what's the problem and, unless we want to check out someone else's branch and run it locally, every wrong syntax costs more GL's pipeline minutes by trying to guess what's wrong, pushing a change, and hoping for the green pipeline.
Just to give an example of CI minutes wasted in one MR bc of this error lacking explanation: !45588 (merged). Note that this is not a big deal, but if we take into account the number of times we/our contributors end up doing this, it should be more significant.
Proposal
- Document indentation for version history notes.
- Explain the very specific origin of the version history's syntax error and/or link the style guide.