Document that YAML files are expected to be in YAML1.2

[skshetry]

Refer iterative/dvc#4415

Fixes #1704

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

[shcheklein]

Looks great overall, I would avoid using notes though

[jorgeorpinel]

Same, just "YAML 1.2"? (Linked)

[jorgeorpinel]

Also, there's several other files that include this params file formats list. Please see #1799 (review)

[jorgeorpinel]

• In fact I'd just grep YAML (upper case and double check all instances (there's 28). DONE SEPARATELY

[skshetry]

Let's not change everywhere, it's enough to mention it in key areas. It's still YAML, so it's fine.

[jorgeorpinel]

Same here, just Same, just "YAML 1.2" please.

it's enough to mention it in key areas

OK but why are the metrics/params index more important than docs/start/experiments or docs/user-guide/basic-concepts/parameter? (or other places)

[jorgeorpinel]

In fact I'd just grep YAML (upper case and double check all instances

I didn't mean change it everywhere BTW, but we need to check all 28 instances please, and decide which ones to change. I think it should definitely be more than just this one

It's a simple change from YAML to "YAML 1.2".

[jorgeorpinel]

Thanks @skshetry ! Left some specific comments above ☝️

p.s. I can polish the language if needed in the next round.

[jorgeorpinel]

Also, questions/requests:

• Should we also review all ```yaml code blocks? That would also address the "Review all .dvc file examples..." check box in docs: Major DVC 1.x discrepancies #1255 — or we can leave for later.
• Maybe note some of these remaks/tips about YAML 1.2 (Document that yaml files are expected to be in YAML v1.2 #1704 (comment)) somewhere in the Metafiles guide?
• Same Q for the note "The workaround will be to add YAML version directive to the top of the file" (from Document that yaml files are expected to be in YAML v1.2 #1704 (comment)) — which I don't fully understand TBH but seems relevant.

[skshetry]

Same Q for the note "The workaround will be to add YAML version directive...

The workaround no longer works, so it's YAML1.2 for now.

[jorgeorpinel]

Thanks for the answers @skshetry. No changes still, please see the open discussions above. Thanks!

[shcheklein]

Merged. It's not that important change to do many iterations to my mind.