open-telemetry
CI: consider adding markdown checks of formatting and common gotchas
Now that we starting to have more and more contributors, the project would benefit from standardizing Markdown formatting, and a prettifier and linter could help in this respect.
- I've (@chalin) started experimenting with Prettier, e.g., see:
- #1290
- https://github.com/open-telemetry/opentelemetry.io/pulls?q=is%3Apr+prettier+is%3Aclosed
- Note that there's module for formatting Go templates. Read more
@svrnm - I've noticed that lately you've been running a markdown linter/prettifier and submitting PRs. Thanks for those.
It would be good if we could agree on the same tool. I'd like to suggest Prettier. I'm open to discussing this at the next Comms meeting if you have a strong preference for another tool.
You can run Prettier as follows:
$ npx prettier --write path/to/the/markdown/file.md
/cc @cartermp @austinlparker
@svrnm - I've noticed that lately you've been running a markdown linter/prettifier and submitting PRs. Thanks for those.
It would be good if we could agree on the same tool. I'd like to suggest Prettier. I'm open to discussing this at the next Comms meeting if you have a strong preference for another tool.
I'm fine with prettier, I just had setup markdownlint to check MD files automatically for me when I open them up, but I can work with prettier as well!
@chalin -- if we add a .prettierrc.json to the project vscode and other editors should be able to pick it up and use prettier (instead of markdownlint in my case). Sounds like a non-invasive first step, wdyt?
if we add a
.prettierrc.jsonto the project vscode and other editors should be able to pick it up and use prettier (instead of markdownlint in my case). Sounds like a non-invasive first step, wdyt?
Sounds good. FYI, there is prettier config already in https://github.com/open-telemetry/opentelemetry.io/blob/25f41e27fc07e62c7e692a7f107e137b49e5eac4/package.json#L52-L54
Is that good enough -- i.e., do tools pick that up? If not, I can factor it out.
Btw, we'll have to be careful with the use of Prettier. It doesn't do a great job with Hugo template syntax. So I'd like to continue experimenting with it before we consider adding it to CI checks. My 2 cents.