[ https://issues.apache.org/jira/browse/FLINK-12651?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Aljoscha Krettek closed FLINK-12651. ------------------------------------ Resolution: Fixed asf-site: 6b35e86404b04d90db7a3fbb665e4af80c10cabe > 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 > Components: Documentation > Reporter: Konstantin Knauf > Assignee: Marta Paes Moreira > Priority: Major > Labels: pull-request-available > Time Spent: 0.5h > Remaining Estimate: 0h > > 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 (v8.3.4#803005)