yuriipalam opened a new pull request, #307:
URL: https://github.com/apache/ozone-site/pull/307

   ## What changes were proposed in this pull request?
   
   Integrate ESLint and Prettier into the project, updated the CI respectively. 
Update all the files that had issues.
   
   [ESLint](https://eslint.org/) is a static code analyzer, so now we have 
analyzer during the development.
   [Prettier](https://prettier.io/) is a formatting tool, so the code style is 
consistent across the files.
   
   Both tools were integrated, as well as relevant extensions to them, e.g., 
[Docusaurus ESLint 
plugin](https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin)
   They were also added to the CI pipeline, so they run in github actions.
   
   Fixed all the issues that the code analyzers found.
   
   Introduced new commands:
   - `pnpm run lint` runs checks only (no files are modified).
   - `pnpm run lint:fix` applies auto-fixes from ESLint, markdownlint, and 
Prettier.
   
   In the project we also have markdownlint, but it has a conflict rule with 
Prettier. Prettier uses `_underscores_` for emphasis, while markdownlint is 
configured to require `*asterisks*`. To keep markdownlint as the source of 
truth for Markdown emphasis, we run markdownlint *after* Prettier.
   
   ## What is the link to the Apache Jira?
   
   [HDDS-9570](https://issues.apache.org/jira/browse/HDDS-9570)
   
   ## How was this patch tested?
   
   Check off which of the following tests were done on this change. If 
additional testing was done, please elaborate here as well.
   
   - [ ] The CI checks on my fork are passing
   - [X] I verified the rendered content using a local preview
   - [X] I manually verified the steps provided in this change work as described
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to