Enable Prettier formatting for documentation

[lb-]

• Exclude release notes as these are long lived and not currently aligned with Prettier preferences
• Exclude the .github/ folder for bespoke requirements in these template files
• Upgrade prettier version & re-format (one css file change)
• See Automated checks for formatting and styleguide in the documentation #8753
• Also Finish first batch of getting started tutorial changes #10579 (comment)

[lb-]

Happy to add something that also reports the exact files that need changing and how, this is a long standing gap in Prettier but there is a work around.

prettier/prettier#6885 (comment)

I understand the main concern for this is that it adds friction for contributors, but think it's still worth doing.

[squash-labs]

Manage this branch in Squash

Test this branch here: https://lb-featureprettier-format-docs-i1e0m.squash.io

[thibaudcolas]

I’m not sure about this one. Perhaps we should format it all by default and use <!-- prettier-ignore --> comments for parts of the files that have very specific formatting?

[laymonage]

It will be very weird to see that comment in the pull request and issue templates though

[lb-]

I can just ignore the one specific file that we have added multiple line-breaks to

[lb-]

I also tried the comment and it did not seem to work.
Used syntax as per https://prettier.io/docs/en/ignore.html#markdown

[lb-]

Rebased this, only ignoring one file in the github folder now (Pull Request template) and also ignoring the contributors.md file.

I did some further investigation into a script to try a git diff output but I think this would not work in our CI.

You do get an output with at least the file name though, for example.

> prettier --check "**/?(.)*.{css,scss,js,ts,tsx,json,yaml,yml,md}"

Checking formatting...
[warn] docs/extending/index.md
[warn] Code style issues found in the above file(s). Forgot to run Prettier?

[lb-]

Going to mark this as a draft, may not be worth pursuing at this time but still keen on feedback from the Google Summer of Docs side of things - @activus-d

[lb-]

Closing this, maintaining this PR is a bit annoying.

Still think it's worth a discussion but I'll bring this up at a core team meeting instead.