flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Konstantin Knauf (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (FLINK-12651) Add "Style Guide" to Documentation Contribution Guide
Date Tue, 28 May 2019 13:41:00 GMT

     [ https://issues.apache.org/jira/browse/FLINK-12651?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Konstantin Knauf updated FLINK-12651:
-------------------------------------
    Component/s: Documentation

> 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
>            Priority: Major
>
> 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)

Mime
View raw message