YAML align indent sizes for docs readability

[nishigori]

This proposal has been aligned in a human readable.

• There are no changes to this except for spac
• The indentation size is not specifically defined in the YAML RFC
  • $ make yaml has passed on my-machine

I set the indentation size to the largest number of articles in the repository (dictionary: 2)

[nishigori]

I'm sorry, I just did sign contributor license agreement 😭

[igalic]

does sphinx / read the docs actually display anything differently, or is this here just for people operating on the source?

[nishigori]

Yes, sphinx / read the docs also makes indenting aligned.

For example, currently sphinx doc is not aligned indent-size
(following chef example is indent-size has 2, and 3)
https://cloudinit.readthedocs.io/en/latest/topics/modules.html#chef

[igalic]

👍

[nishigori]

@igalic thanks your review.

I was signed the contributor license agreement https://launchpad.net/~nishigori-tak

Please re-run github workflows for cla-validate
( I don't have writing privileges, so I can't run it 🙏 )

[OddBloke]

Hi @nishigori, I see your signature in our internal tracking system. We just need you to add your name to https://github.com/canonical/cloud-init/blob/master/tools/.github-cla-signers (you should be able to do it as part of this PR), for our automated check to pass.

(I haven't reviewed this yet, FYI, just unblocking you on that particular part of the process. 👍)

[OddBloke]

OK, I'm going to have a look at this now. Thanks for the submission!

One idea that occurs to me is adding some sort of YAML indentation linting check to our CI, so that we will catch any inconsistencies before they're introduced in future. @nishigori, would you be interested in contributing such a check?

[OddBloke]

Thanks for taking this on, I think this will be a definite improvement to the docs. I've left some inline comments where I think you may have missed something, but overall this looks really good!

[OddBloke]

Should this (and all the following lines) be indented two extra spaces?

[nishigori]

It's not necessary, but I was aligned same like with other files

[nishigori]

Hi, @OddBloke thanks your review.

One idea that occurs to me is adding some sort of YAML indentation linting check to our CI, so that we will catch any inconsistencies before they're introduced in future. @nishigori, would you be interested in contributing such a check?

Of course. Specifically, I'd like to turn yamllint or editorconfig in CI.

Your review points (mainly indentations in list) I'd like to fix it after running CI in this PR

[OddBloke]

On Mon, Apr 20, 2020 at 07:58:10PM -0700, Tak Nishigori wrote: Hi, @OddBloke thanks your review.

Of course. :)

> One idea that occurs to me is adding some sort of YAML indentation > linting check to our CI, so that we will catch any inconsistencies > before they're introduced in future. @nishigori, would you be > interested in contributing such a check? Of course. Specifically, I'd like to turn [yamllint](https://github.com/adrienverge/yamllint) or [editorconfig](https://editorconfig.org/) in CI.

OK, great!

Your review points (mainly indentations in `list`) I'd like to fix it after running it in CI

To be clear, I wasn't asking for the linter in this PR. If we fix up the inconsistencies I've identified (excluding the ones to lists, if you would prefer), then I think we can land this (as it's a clear improvement even without a linter) and you can propose a linter as a follow-up PR. How does that sound? Thanks! Dan

[nishigori]

Thanks, this PR is only fixed indent alignment (with your identified)

you can propose a linter as a follow-up PR. How does that sound?

That's right, it is for another time

[OddBloke]

LGTM now, thank you!