Skip to content
Permalink
Browse files
[FLINK-12651] Add a Documentation Style Guide
  • Loading branch information
morsapaes authored and aljoscha committed Feb 14, 2020
1 parent 182067e commit 6b35e86404b04d90db7a3fbb665e4af80c10cabe
Show file tree
Hide file tree
Showing 5 changed files with 1,022 additions and 1 deletion.
@@ -19,6 +19,7 @@ en:
review_code: Review Pull Requests
code_style_guide: Code Style and Quality Guide
contribute_docs: Contribute Documentation
docs_style_guide: Documentation Style Guide
contribute_website: Contribute to the Website
roadmap: Roadmap
tutorials: Tutorials
@@ -44,6 +45,7 @@ zh:
review_code: 审核 Pull Request
code_style_guide: 代码样式与质量指南
contribute_docs: 贡献文档
docs_style_guide: Documentation Style Guide
contribute_website: 贡献网站
roadmap: 开发计划
tutorials: 教程
@@ -114,6 +114,9 @@
<li {% if page.url contains '/contributing/contribute-documentation.html' %} class="active"{% endif %}>
<a href="{{ baseurl_i18n }}/contributing/contribute-documentation.html">{{ site.data.i18n[page.language].contribute_docs }}</a>
</li>
<li {% if page.url contains '/contributing/docs-style.html' %} class="active"{% endif %}>
<a href="{{ baseurl_i18n }}/contributing/docs-style.html">{{ site.data.i18n[page.language].docs_style_guide }}</a>
</li>
<li {% if page.url contains '/contributing/improve-website.html' %} class="active"{% endif %}>
<a href="{{ baseurl_i18n }}/contributing/improve-website.html">{{ site.data.i18n[page.language].contribute_website }}</a>
</li>
@@ -22,7 +22,9 @@ The documentation is located in the `docs/` subdirectory of the Flink code base.

## Before you start working on the documentation ...

... please make sure there exists a [Jira](https://issues.apache.org/jira/browse/FLINK) issue that corresponds to your contribution. We require all documentation changes to refer to a Jira issue, except for trivial fixes such as typos.
... please make sure there exists a [Jira](https://issues.apache.org/jira/browse/FLINK) issue that corresponds to your contribution. We require all documentation changes to refer to a Jira issue, except for trivial fixes such as typos.

Also, have a look at the [Documentation Style Guide]({{ site.baseurl }}/contributing/docs-style.html) for some guidance on how to write accessible, consistent and inclusive documentation.

## Update or extend the documentation

0 comments on commit 6b35e86

Please sign in to comment.