You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(ci): have prettier ignore mkdocs .yml files (#18925)
# Overview
Add a rule to our `.eslintignore` file so `prettier` doesn't complain
about unimportant formatting quirks in mkdocs YAML configuration files.
Unlike the rule to ignore .md files, which is _required_ for proper
mkdocs output, this is for convenience. But, the fact that a missing or
stray newline here or there in fully functioning docs configuration
files can cause the "JS checks" for our entire software stack to fail is
not representative. It puts a lot on the documentation authors to make
sure they don't mess things up for the whole software team when working
in what should be a completely siloed environment.
## Test Plan and Hands on Testing
In local environment, removed an EOF newline (the sheer audacity!) in
`docs/flex-manual/mkdocs.yml` and ran `make lint-js`.
## Changelog
Just the one ignore rule.
## Review requests
Any real reason not to do this?
## Risk assessment
v low.
0 commit comments