Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce Prettier formatting in docs/config.json config files #331

Open
ptgott opened this issue Jun 30, 2023 · 0 comments
Open

Enforce Prettier formatting in docs/config.json config files #331

ptgott opened this issue Jun 30, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@ptgott
Copy link
Contributor

ptgott commented Jun 30, 2023

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.

@ptgott ptgott added the enhancement New feature or request label Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant