Konstantin Knauf created FLINK-12651:
----------------------------------------
Summary: Add "Style Guide" to Documentation Contribution Guide
Key: FLINK-12651
URL: https://issues.apache.org/jira/browse/FLINK-12651
Project: Flink
Issue Type: Sub-task
Reporter: Konstantin Knauf
As part of this FLIP we would like to align on a few standards & guidelines for
our documentation.
The current guide only focuses on the process and technical aspects:
https://flink.apache.org/contribute-documentation.html
https://flink.apache.org/how-to-contribute.html#contribute-documentation
We would like to expand on this for things like:
* when to use "note" or "attention" tags
* where the table of contents should be placed on a page
* when to split up pages
* how to address the user
* when to add code samples in Java & Scala
* ...
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
