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
When docs contributors edit the docs/config.json configuration file within a version-specific gravitational/teleport submodule, differences in editor configuration often cause minor formatting changes that lead to larger-than-intended diffs and merge conflicts for backports.
Since we already enforce the use of prettier for JS files, we can edit our docs linting workflow to ensure that any docs/config.json file passes prettier --check. We'll also want to include some clear language in the error message instructing the author to install Prettier and run prettier -w config.json.
The text was updated successfully, but these errors were encountered:
When docs contributors edit the
docs/config.json
configuration file within a version-specificgravitational/teleport
submodule, differences in editor configuration often cause minor formatting changes that lead to larger-than-intended diffs and merge conflicts for backports.Since we already enforce the use of
prettier
for JS files, we can edit our docs linting workflow to ensure that anydocs/config.json
file passesprettier --check
. We'll also want to include some clear language in the error message instructing the author to install Prettier and runprettier -w config.json
.The text was updated successfully, but these errors were encountered: