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.

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

[hotfix] Various Typos / Grammar / Clarity Fixes Across Documentations #469

Open
wants to merge 10 commits into
base: asf-site
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _posts/2021-04-29-release-1.12.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ List of resolved issues:
</li>
<li>[<a href='https://issues.apache.org/jira/browse/FLINK-21431'>FLINK-21431</a>] - UpsertKafkaTableITCase.testTemporalJoin hang
</li>
<li>[<a href='https://issues.apache.org/jira/browse/FLINK-21434'>FLINK-21434</a>] - When UDAF return ROW type, and the number of fields is more than 14, the crash happend
<li>[<a href='https://issues.apache.org/jira/browse/FLINK-21434'>FLINK-21434</a>] - When UDAF return ROW type, and the number of fields is more than 14, the crash happened
</li>
<li>[<a href='https://issues.apache.org/jira/browse/FLINK-21497'>FLINK-21497</a>] - JobLeaderIdService completes leader future despite no leader being elected
</li>
Expand Down
2 changes: 1 addition & 1 deletion community.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ If you send us an email with a code snippet, make sure that:

Committers are watching [Stack Overflow](http://stackoverflow.com/questions/tagged/apache-flink) for the [apache-flink](http://stackoverflow.com/questions/tagged/apache-flink) tag.

Make sure to tag your questions there accordingly to get answers from the Flink community.
Make sure to tag your questions accordingly to get answers from the Flink community.

## Issue Tracker

Expand Down
2 changes: 1 addition & 1 deletion content/blog/feed.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3409,7 +3409,7 @@ zhushang, zhuxiaoshang, Zhu Zhu, zjuwangg, zoucao, zoudan, 左元, 星, 肖佳
&lt;/li&gt;
&lt;li&gt;[&lt;a href=&quot;https://issues.apache.org/jira/browse/FLINK-21431&quot;&gt;FLINK-21431&lt;/a&gt;] - UpsertKafkaTableITCase.testTemporalJoin hang
&lt;/li&gt;
&lt;li&gt;[&lt;a href=&quot;https://issues.apache.org/jira/browse/FLINK-21434&quot;&gt;FLINK-21434&lt;/a&gt;] - When UDAF return ROW type, and the number of fields is more than 14, the crash happend
&lt;li&gt;[&lt;a href=&quot;https://issues.apache.org/jira/browse/FLINK-21434&quot;&gt;FLINK-21434&lt;/a&gt;] - When UDAF return ROW type, and the number of fields is more than 14, the crash happened
&lt;/li&gt;
&lt;li&gt;[&lt;a href=&quot;https://issues.apache.org/jira/browse/FLINK-21497&quot;&gt;FLINK-21497&lt;/a&gt;] - JobLeaderIdService completes leader future despite no leader being elected
&lt;/li&gt;
Expand Down
2 changes: 1 addition & 1 deletion content/community.html
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ <h2 id="stack-overflow">Stack Overflow</h2>

<p>Committers are watching <a href="http://stackoverflow.com/questions/tagged/apache-flink">Stack Overflow</a> for the <a href="http://stackoverflow.com/questions/tagged/apache-flink">apache-flink</a> tag.</p>

<p>Make sure to tag your questions there accordingly to get answers from the Flink community.</p>
<p>Make sure to tag your questions accordingly to get answers from the Flink community.</p>

<h2 id="issue-tracker">Issue Tracker</h2>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ <h4 id="compatibility">Compatibility</h4>

<ul>
<li>Backwards compatibility for state in streaming SQL relies on the fact that the physical execution plan remains stable. Otherwise the generated Operator Names/IDs change and state cannot be matched and restored.</li>
<li>Every bug fix that leads to changes in the optimized physical plan of a streaming pipeline hences breaks compatibility.</li>
<li>Every bug fix that leads to changes in the optimized physical plan of a streaming pipeline hence breaks compatibility.</li>
<li>As a consequence, changes of the kind that lead to different optimizer plans can only be merged in major releases for now.</li>
</ul>

Expand Down
2 changes: 1 addition & 1 deletion content/contributing/code-style-and-quality-preamble.html
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ <h1>Apache Flink Code Style and Quality Guide — Preamble</h1>
<ol>
<li id="fn:1">

<p>In earlier days, we (the Flink community) did not always pay sufficient attention to this, making some components of Flink harder to evolve and to contribute to. <a href="#fnref:1" class="reversefootnote">&#8617;</a></p>
<p>In earlier days, we (the Flink community) did not always pay sufficient attention to this, making some components of Flink harder to evolve and contribute to. <a href="#fnref:1" class="reversefootnote">&#8617;</a></p>
</li>
</ol>
</div>
Expand Down
2 changes: 1 addition & 1 deletion content/contributing/docs-style.html
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ <h3 id="code">Code</h3>
<li>
<p><strong>Commands in code blocks.</strong> Commands can be documented using <code>bash</code> syntax
highlighted code blocks. The following items should be considered when adding
commands to the docummentation:</p>
commands to the documentation:</p>
<ul>
<li><strong>Use long parameter names.</strong> Long parameter names help the reader to
understand the purpose of the command. They should be preferred over their
Expand Down
2 changes: 1 addition & 1 deletion content/contributing/reviewing-prs.html
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ <h3 id="does-the-contribution-need-attention-from-some-specific-committers-and-i

<h3 id="does-the-implementation-follow-the-agreed-upon-overall-approacharchitecture">4. Does the Implementation Follow the Agreed Upon Overall Approach/Architecture?</h3>

<p>In this step, we check if a contribution folllows the agreed upon approach from the previous discussion in Jira or the mailing lists.</p>
<p>In this step, we check if a contribution follows the agreed upon approach from the previous discussion in Jira or the mailing lists.</p>

<p>This question should be answerable from the Pull Request description (or the linked Jira) as much as possible.</p>

Expand Down
6 changes: 3 additions & 3 deletions content/gettinghelp.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ <h1>Getting Help</h1>

<div class="page-toc">
<ul id="markdown-toc">
<li><a href="#having-a-question" id="markdown-toc-having-a-question">Having a Question?</a> <ul>
<li><a href="#have-a-question" id="markdown-toc-have-a-question">Have a Question?</a> <ul>
<li><a href="#user-mailing-list" id="markdown-toc-user-mailing-list">User Mailing List</a></li>
<li><a href="#stack-overflow" id="markdown-toc-stack-overflow">Stack Overflow</a></li>
</ul>
Expand All @@ -220,7 +220,7 @@ <h1>Getting Help</h1>

</div>

<h2 id="having-a-question">Having a Question?</h2>
<h2 id="have-a-question">Have a Question?</h2>

<p>The Apache Flink community answers many user questions every day. You can search for answers and advice in the archives or reach out to the community for help and guidance.</p>

Expand Down Expand Up @@ -252,7 +252,7 @@ <h2 id="found-a-bug">Found a Bug?</h2>

<p>If you observe an unexpected behavior that might be caused by a bug, you can search for reported bugs or file a bug report in <a href="https://issues.apache.org/jira/issues/?jql=project %3D FLINK">Flink’s JIRA</a>.</p>

<p>If you are unsure whether the unexpected behavior happend due to a bug or not, please post a question to the <a href="#user-mailing-list">user mailing list</a>.</p>
<p>If you are unsure whether the unexpected behavior happened due to a bug or not, please post a question to the <a href="#user-mailing-list">user mailing list</a>.</p>

<h2 id="got-an-error-message">Got an Error Message?</h2>

Expand Down
2 changes: 1 addition & 1 deletion content/news/2021/04/29/release-1.12.3.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h2> Bug
</li>
<li>[<a href="https://issues.apache.org/jira/browse/FLINK-21431">FLINK-21431</a>] - UpsertKafkaTableITCase.testTemporalJoin hang
</li>
<li>[<a href="https://issues.apache.org/jira/browse/FLINK-21434">FLINK-21434</a>] - When UDAF return ROW type, and the number of fields is more than 14, the crash happend
<li>[<a href="https://issues.apache.org/jira/browse/FLINK-21434">FLINK-21434</a>] - When UDAF return ROW type, and the number of fields is more than 14, the crash happened
</li>
<li>[<a href="https://issues.apache.org/jira/browse/FLINK-21497">FLINK-21497</a>] - JobLeaderIdService completes leader future despite no leader being elected
</li>
Expand Down
4 changes: 2 additions & 2 deletions content/roadmap.html
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ <h2 id="a-unified-sql-platform">A unified SQL Platform</h2>

<ul>
<li>Change-Data-Capture: Capturing a stream of data changes, directly from databases, by attaching to the
transaction log. The community is adding more CDC intrgrations.
transaction log. The community is adding more CDC integrations.
<ul>
<li>External CDC connectors: <a href="https://flink-packages.org/packages/cdc-connectors">https://flink-packages.org/packages/cdc-connectors</a></li>
<li>Background: <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=147427289">FLIP-105</a>
Expand Down Expand Up @@ -445,7 +445,7 @@ <h1 id="applications-vs-clusters-flink-as-a-library">Applications vs. Clusters;
<ul>
<li>
<p>Reactive Scaling lets Flink applications change their parallelism in response to growing and shrinking
worker pools, and makes Flink compatibel with standard auto-scalers:
worker pools, and makes Flink compatible with standard auto-scalers:
<a href="https://cwiki.apache.org/confluence/display/FLINK/FLIP-159%3A+Reactive+Mode">FLIP-159</a></p>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion contributing/code-style-and-quality-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Avoid full integration tests
Don’t introduce physical plan changes in minor releases!

* Backwards compatibility for state in streaming SQL relies on the fact that the physical execution plan remains stable. Otherwise the generated Operator Names/IDs change and state cannot be matched and restored.
* Every bug fix that leads to changes in the optimized physical plan of a streaming pipeline hences breaks compatibility.
* Every bug fix that leads to changes in the optimized physical plan of a streaming pipeline hence breaks compatibility.
* As a consequence, changes of the kind that lead to different optimizer plans can only be merged in major releases for now.


Expand Down
2 changes: 1 addition & 1 deletion contributing/code-style-and-quality-preamble.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ A big part of high-quality open source contributions is about helping the review
<hr>

[^1]:
In earlier days, we (the Flink community) did not always pay sufficient attention to this, making some components of Flink harder to evolve and to contribute to.
In earlier days, we (the Flink community) did not always pay sufficient attention to this, making some components of Flink harder to evolve and contribute to.
2 changes: 1 addition & 1 deletion contributing/docs-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ Or using plain HTML:

* **Commands in code blocks.** Commands can be documented using `bash` syntax
highlighted code blocks. The following items should be considered when adding
commands to the docummentation:
commands to the documentation:
* **Use long parameter names.** Long parameter names help the reader to
understand the purpose of the command. They should be preferred over their
short counterparts.
Expand Down
2 changes: 1 addition & 1 deletion contributing/reviewing-prs.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ This question can be answered with

### 4. Does the Implementation Follow the Agreed Upon Overall Approach/Architecture?

In this step, we check if a contribution folllows the agreed upon approach from the previous discussion in Jira or the mailing lists.
In this step, we check if a contribution follows the agreed upon approach from the previous discussion in Jira or the mailing lists.

This question should be answerable from the Pull Request description (or the linked Jira) as much as possible.

Expand Down
4 changes: 2 additions & 2 deletions gettinghelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: "Getting Help"

{% toc %}

## Having a Question?
## Have a Question?

The Apache Flink community answers many user questions every day. You can search for answers and advice in the archives or reach out to the community for help and guidance.

Expand Down Expand Up @@ -34,7 +34,7 @@ Many members of the Flink community are active on [Stack Overflow](https://stack

If you observe an unexpected behavior that might be caused by a bug, you can search for reported bugs or file a bug report in [Flink's JIRA](https://issues.apache.org/jira/issues/?jql=project %3D FLINK).

If you are unsure whether the unexpected behavior happend due to a bug or not, please post a question to the [user mailing list](#user-mailing-list).
If you are unsure whether the unexpected behavior happened due to a bug or not, please post a question to the [user mailing list](#user-mailing-list).

## Got an Error Message?

Expand Down
4 changes: 2 additions & 2 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ integrations. With user feedback, those are continuously improved.
**More Connector and Change Data Capture Support**

- Change-Data-Capture: Capturing a stream of data changes, directly from databases, by attaching to the
transaction log. The community is adding more CDC intrgrations.
transaction log. The community is adding more CDC integrations.
- External CDC connectors: [https://flink-packages.org/packages/cdc-connectors](https://flink-packages.org/packages/cdc-connectors)
- Background: [FLIP-105](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=147427289)
(CDC support for SQL) and [Debezium](https://debezium.io/).
Expand Down Expand Up @@ -193,7 +193,7 @@ Deploy Flink jobs as self-contained Applications works for all deployment target
([FLIP-85](https://cwiki.apache.org/confluence/display/FLINK/FLIP-85+Flink+Application+Mode)).

- Reactive Scaling lets Flink applications change their parallelism in response to growing and shrinking
worker pools, and makes Flink compatibel with standard auto-scalers:
worker pools, and makes Flink compatible with standard auto-scalers:
[FLIP-159](https://cwiki.apache.org/confluence/display/FLINK/FLIP-159%3A+Reactive+Mode)

- Kubernetes-based HA-services let Flink applications run on Kubernetes without requiring a ZooKeeper dependency:
Expand Down