Hi Zhongpu, Thanks for starting this discussion. I was wondering how we could let every contributor follow the same mk rule. I am not familiar with Prettier. Would you like to help me understand some basic questions? Thanks.
Is there any way to integrate the format check into our CI pipeline? Otherwise, it will be hard to control it. Another thing is that some docs are written with Hugo syntax [1]. Would they work together with no conflict? Best regards, Jing [1] https://gohugo.io/ On Wed, Feb 22, 2023 at 9:50 AM Zhongpu Chen <chenlov...@gmail.com> wrote: > As I mentioned in FLINK-31177 ( > https://issues.apache.org/jira/browse/FLINK-31177): > > Currently, markdown files in *docs* are maintained and updated by many > contributors, and different people have varying code style taste. By the > way, as the syntax of markdown is not really strict, the styles tend to be > inconsistent. > > To name a few, > > - Some prefer `*` to make a list item, while others may prefer `-`. > - It is common to leave many unnecessary blank lines and spaces. > - To make a divider, the number of `-` can be varying. > > To this end, I think it would be nicer to encourage or demand contributors > to format their markdown files before making a pull request. Personally, I > think Prettier (https://prettier.io/) is a good candidate. > What do you think? > > -- > Zhongpu Chen >
