Hi Devs,

First of all, I'd like to thank everyone for being more proactive about
writing documentation along with their features. Compared to previous
releases there is not so much last-minute documentation writing and that is
something to be celebrated!

That said, we are still beginning to see an influx in documentation PRs and
I would just like to remind the committers to always build the
documentation locally when reviewing non trivial changes. This practice
helps ensure any inline liquid tags or HTML properly renders. Additionally,
if new pages or links are being added you may run the
`./docs/check_links.sh` script to test for broken links. Documentation is
most users' first introduction to Flink so it is important we provide them
a pleasant experience.

Finally, if you are ever unsure how something should be phrased or
formatted please refer to the contribution guidelines or feel free to ping
me directly[1].

Cheers,

Seth

[1] https://flink.apache.org/contributing/docs-style.html

Reply via email to