docs: avoid the misleading comment

[spacewander]

Also remove helpless yaml lint.

Fix #3962
Signed-off-by: spacewander spacewanderlzx@gmail.com

What this PR does / why we need it:

Pre-submission checklist:

• Did you explain what problem does this PR solve? Or what new features have been added?
• Have you added corresponding test cases?
• Have you modified the corresponding document?
• Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

[jbampton]

Why are you removing this test ?
Without the YAML lint test on the CI we will probably go backwards.
You can always just ignore YAML files or folders with yamllint or ignore tests in whole files.

The YAML comment syntax is configurable:

[spacewander]

If we ignore it, there is almost nothing left that can be checked.

I quite regard about accepting yamllint. Several months have been passed, it has been proved that the linter is helpless but causes misleading and inconvenient.

[spacewander]

Don't try to sell us linter anymore...
We are not an experimental lab for such "modern" technologies.

[jbampton]

You are wrong again since the comments disable rule is only one yamllint rule and there are many to check.

There are about 20 yamllint rules :)

Also most of the worlds top projects use yamllint like Apache Airflow and they know it's not helpless.

https://yamllint.readthedocs.io/en/latest/rules.html