One of the goals for FLIP-42[1] is to introduce a documentation style guide to the Flink community. Similar to the Checkstyle used to keep the Flink's source code consistent, we should have a standard style for all pages of the documentation. Doing so will allow full community involvement in growing the documentation while maintaining a consistent tone and structure. We want something that can both be implemented by a multilingual group of developers, and that produces something that can be consumed by a multilingual set of users.
Marta (cc'd) has opened a pull request with an initial draft[2].
Unlike the code style guide that was recently introduced, this does not try and codify the existing structure since the documentation style tends to vary wildly from section to section. Instead, the guide looks to other projects and their best practices.
We look forward to hearing the community's feedback.
Seth Wiesman
[1]
https://cwiki.apache.org/confluence/display/FLINK/FLIP-42%3A+Rework+Flink+Documentation[2]
https://github.com/apache/flink-web/pull/240
Locked
