Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FLINK-12651][docs] Documentation Style Guide. #240

Closed
wants to merge 5 commits into from
Closed

[FLINK-12651][docs] Documentation Style Guide. #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b65d99c
Merge pull request #1 from apache/asf-site
morsapaes Jul 23, 2019
03d7723
[FLINK-12651] Documentation Style Guide.
morsapaes Aug 5, 2019
95f4fbb
Adding in the guideline regarding the inclusion of the Apache License…
morsapaes Aug 7, 2019
b6cbcff
Update contributing/docs-style.md
morsapaes Aug 16, 2019
9bf5215
Twitched the general principles section according to Robert's suggest…
morsapaes Aug 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions _data/i18n.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,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

Expand Down
3 changes: 3 additions & 0 deletions _includes/navbar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,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>
Expand Down
2 changes: 1 addition & 1 deletion contributing/contribute-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ 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

Expand Down