Github user alpinegizmo commented on a diff in the pull request:
https://github.com/apache/flink/pull/4760#discussion_r142630633
--- Diff: docs/index.md ---
@@ -25,27 +25,26 @@ under the License.
-This documentation is for Apache Flink version {{ site.version_title }}.
These pages have been built at: {% build_time %}.
+This documentation is for Apache Flink version {{ site.version_title }}.
These pages were built at: {% build_time %}.
-Apache Flink is an open source platform for distributed stream and batch
data processing. Flinkâs core is a streaming dataflow engine that provides
data distribution, communication, and fault tolerance for distributed
computations over data streams. Flink also builds batch processing on top of
the streaming engine, overlaying native iteration support, managed memory, and
program optimization.
+Apache Flink is an open source platform for distributed stream and batch
data processing. Flinkâs core is a streaming dataflow engine that provides
data distribution, communication, and fault tolerance for distributed
computations over data streams. Flink builds batch processing on top of the
streaming engine, overlaying native iteration support, managed memory, and
program optimization.
## First Steps
-- **Concepts**: Start with the basic concepts of Flink's [Dataflow
Programming Model](concepts/programming-model.html) and [Distributed Runtime
Environment](concepts/runtime.html). This will help you to fully understand the
other parts of the documentation, including the setup and programming guides.
It is highly recommended to read these sections first.
+- **Concepts**: Start with the basic concepts of Flink's [Dataflow
Programming Model](concepts/programming-model.html) and [Distributed Runtime
Environment](concepts/runtime.html). This will help you understand other parts
of the documentation, including the setup and programming guides. We
recommended you read these sections first.
- **Quickstarts**: [Run an example
program](quickstart/setup_quickstart.html) on your local machine or [study some
examples](examples/index.html).
-- **Programming Guides**: You can check out our guides about [basic API
concepts](dev/api_concepts.html) and the [DataStream
API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn
how to write your first Flink programs.
+- **Programming Guides**: You can read our guides about [basic API
concepts](dev/api_concepts.html) and the [DataStream
API](dev/datastream_api.html) or the [DataSet API](dev/batch/index.html) to
learn how to write your first Flink programs.
## Deployment
-Before putting your Flink job into production, be sure to read the
[Production Readiness Checklist](ops/production_ready.html).
+Before putting your Flink job into production, read the [Production
Readiness Checklist](ops/production_ready.html).
## Migration Guide
-For users of earlier versions of Apache Flink we recommend the [API
migration guide](dev/migration.html).
-While all parts of the API that were marked as public and stable are still
supported (the public API is backwards compatible), we suggest migrating
applications to the
-newer interfaces where applicable.
+For users of earlier versions of Apache Flink, we recommend the [API
migration guide](dev/migration.html).
+While all parts of the API marked as public and stable are still supported
(the public API is backwards compatible), we suggest migrating applications to
the newer interfaces where applicable.
--- End diff --
I think "were marked" better communicates the intent here, as it is saying
that the parts of the API that were marked as public and stable in previous
releases are still supported (regardless of how they are currently marked).
Otherwise, +1.
---
