You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by sj...@apache.org on 2020/06/12 16:03:48 UTC
[flink] branch master updated (86b17c2 -> 481c509)
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git.
from 86b17c2 [FLINK-17315][tests] Ignore unstable UnalignedCheckpointITCase one more time
new b25f464 [FLINK-17981][docs] rewrite docs home page
new 1735af8 [FLINK-17981][docs] Link to statefun docs from the home page
new 308ef58 [FLINK-17981][docs] Improvements to layout and content based on reviews
new 481c509 [FLINK-17981][docs] Add a section on getting help to the home page
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/_config.yml | 3 ++
docs/index.md | 83 ++++++++++++++++++++++++++++++++++----------------------
2 files changed, 54 insertions(+), 32 deletions(-)
[flink] 04/04: [FLINK-17981][docs] Add a section on getting help to
the home page
Posted by sj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 481c509f2e034c912e5e5d278e0b3f3d29a21f2b
Author: David Anderson <da...@alpinegizmo.com>
AuthorDate: Fri Jun 12 12:28:32 2020 +0200
[FLINK-17981][docs] Add a section on getting help to the home page
This closes #12556
---
docs/index.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index bc96733..afccb69 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -23,7 +23,7 @@ specific language governing permissions and limitations
under the License.
-->
-<p style="margin: 30px 60px 0 60px" markdown="1">
+<p style="margin: 30px 60px 0 60px;text-align: center" markdown="1">
Apache Flink is a framework and distributed processing engine for stateful computations over _unbounded and bounded_ data streams. Flink has been designed to run in _all common cluster environments_, perform computations at _in-memory speed_ and at _any scale_.
</p>
@@ -45,6 +45,10 @@ If you’re interested in playing around with Flink, try one of our tutorials:
* The [Concepts]({% link concepts/index.md %}) section explains what you need to know about Flink before exploring the reference documentation.
+### Get Help with Flink
+
+If you get stuck, check out our [community support resources](https://flink.apache.org/community.html). In particular, Apache Flink’s user mailing list is consistently ranked as one of the most active of any Apache project, and is a great way to get help quickly.
+
</div>
<div class="col-sm-6" markdown="1">
@@ -86,4 +90,4 @@ See the release notes for [Flink 1.10]({% link release-notes/flink-1.10.md %}),
<p>
This documentation is for Apache Flink version {{ site.version_title }}. These pages were built at: {% build_time %}.
</p>
-</div>
\ No newline at end of file
+</div>
[flink] 02/04: [FLINK-17981][docs] Link to statefun docs from the
home page
Posted by sj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 1735af86d119ba87e776e872497a14a40c426ae3
Author: David Anderson <da...@alpinegizmo.com>
AuthorDate: Wed Jun 10 11:00:34 2020 +0200
[FLINK-17981][docs] Link to statefun docs from the home page
---
docs/_config.yml | 3 +++
docs/index.md | 4 ++--
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index e6786e5..e0ff918 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -57,6 +57,9 @@ stable_baseurl: //ci.apache.org/projects/flink/flink-docs-stable
javadocs_baseurl: //ci.apache.org/projects/flink/flink-docs-master
pythondocs_baseurl: //ci.apache.org/projects/flink/flink-docs-master
+statefundocs_baseurl: //ci.apache.org/projects/flink/flink-statefun-docs-master
+statefundocs_stable_baseurl: //ci.apache.org/projects/flink/flink-statefun-docs-stable
+
# Flag whether this is a stable version or not. Used for the quickstart page.
is_stable: false
diff --git a/docs/index.md b/docs/index.md
index 68b21eb..2493c1a 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -43,7 +43,7 @@ To quickly get a general understanding of how Flink works and what it offers for
* Our [Self-paced Training Course]({% link learn-flink/index.md %}) includes a set of lessons and hands-on exercises that provide a step-by-step introduction to Flink.
-* The [Concepts]({% link concepts/index.md %}) section covers what you need to know about Flink before exploring the reference documentation.
+* The [Concepts]({% link concepts/index.md %}) section explains what you need to know about Flink before exploring the reference documentation.
</div>
<div class="col-sm-6" markdown="1">
@@ -56,8 +56,8 @@ The reference documentation covers all the details. Some starting points:
<div class="col-sm-6" markdown="1">
* [DataStream API]({% link dev/datastream_api.md %})
-* [DataSet API]({% link dev/batch/index.md %})
* [Table API & SQL]({% link dev/table/index.md %})
+* [Stateful Functions]({% if site.is_stable %} {{ site.statefundocs_stable_baseurl }} {% else %} {{ site.statefundocs_baseurl }} {% endif %})
</div>
<div class="col-sm-6" markdown="1">
[flink] 01/04: [FLINK-17981][docs] rewrite docs home page
Posted by sj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit b25f46486224c36cc212b80635c85b473a2a171e
Author: David Anderson <da...@alpinegizmo.com>
AuthorDate: Mon Jun 8 19:58:28 2020 +0200
[FLINK-17981][docs] rewrite docs home page
---
docs/index.md | 72 ++++++++++++++++++++++++++++++++++-------------------------
1 file changed, 41 insertions(+), 31 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 4f9ad2b..68b21eb 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -25,50 +25,60 @@ under the License.
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 builds batch processing on top of the streaming engine, overlaying native iteration support, managed memory, and program optimization.
+<div class="row">
+<div class="col-sm-6" markdown="1">
-## First Steps
+### Try Flink
-* **Code Walkthroughs**: Follow step-by-step guides and implement a simple application or query in one of Flink's APIs.
- * [Implement a DataStream application]({% link try-flink/datastream_api.md %})
- * [Write a Table API query]({% link try-flink/table_api.md %})
+Apache Flink is an open source platform with expressive APIs for defining stream and batch data processing jobs, and a robust and scalable engine for executing those jobs.
-* **Docker Playgrounds**: Set up a sandboxed Flink environment in just a few minutes to explore and play with Flink.
- * [Run and manage Flink streaming applications]({% link try-flink/flink-operations-playground.md %})
+To quickly get a general understanding of how Flink works and what it offers for your use case, work your way through one of these tutorials:
-* **Concepts**: Learn about Flink's concepts to better understand the documentation.
- * [Stateful Stream Processing](concepts/stateful-stream-processing.html)
- * [Timely Stream Processing](concepts/timely-stream-processing.html)
- * [Flink Architecture](concepts/flink-architecture.html)
- * [Glossary](concepts/glossary.html)
+* [Fraud Detection with the DataStream API]({% link try-flink/datastream_api.md %})
+* [Real Time Reporting with the Table API]({% link try-flink/table_api.md %})
+* [Intro to the Python Table API]({% link try-flink/python_table_api.md %})
+* [Flink Operations Playground]({% link try-flink/flink-operations-playground.md %})
-## API References
+### Learn Flink
-The API references list and explain all features of Flink's APIs.
+* Our [Self-paced Training Course]({% link learn-flink/index.md %}) includes a set of lessons and hands-on exercises that provide a step-by-step introduction to Flink.
-* [DataStream API](dev/datastream_api.html)
-* [DataSet API](dev/batch/index.html)
-* [Table API & SQL](dev/table/index.html)
+* The [Concepts]({% link concepts/index.md %}) section covers what you need to know about Flink before exploring the reference documentation.
-## Deployment
+</div>
+<div class="col-sm-6" markdown="1">
-Before putting your Flink job into production, read the [Production Readiness Checklist](ops/production_ready.html).
+### Explore Flink
-## Release Notes
+The reference documentation covers all the details. Some starting points:
-Release notes cover important changes between Flink versions. Please carefully read these notes if you plan to upgrade your Flink setup to a later version.
+<div class="row">
+<div class="col-sm-6" markdown="1">
-* [Release notes for Flink 1.10](release-notes/flink-1.10.html).
-* [Release notes for Flink 1.9](release-notes/flink-1.9.html).
-* [Release notes for Flink 1.8](release-notes/flink-1.8.html).
-* [Release notes for Flink 1.7](release-notes/flink-1.7.html).
-* [Release notes for Flink 1.6](release-notes/flink-1.6.html).
-* [Release notes for Flink 1.5](release-notes/flink-1.5.html).
+* [DataStream API]({% link dev/datastream_api.md %})
+* [DataSet API]({% link dev/batch/index.md %})
+* [Table API & SQL]({% link dev/table/index.md %})
-## External Resources
+</div>
+<div class="col-sm-6" markdown="1">
-- **Flink Forward**: Talks from past conferences are available at the [Flink Forward](http://flink-forward.org/) website and on [YouTube](https://www.youtube.com/channel/UCY8_lgiZLZErZPF47a2hXMA). [Robust Stream Processing with Apache Flink](http://2016.flink-forward.org/kb_sessions/robust-stream-processing-with-apache-flink/) is a good place to start.
+* [Configuration]({% link ops/config.md %})
+* [Rest API]({% link monitoring/rest_api.md %})
+* [CLI]({% link ops/cli.md %})
-- **Training**: The [training materials](https://training.ververica.com/) from Ververica include slides, exercises, and sample solutions.
+</div>
+</div>
+
+### Deploy Flink
+
+Before putting your Flink job into production, read the [Production Readiness Checklist]({% link ops/production_ready.md %}). For an overview of possible deployment targets, see [Clusters and Deployments]({% link ops/deployment/index.md %}).
+
+### Upgrade Flink
+
+Release notes cover important changes between Flink versions. Please read them carefully if you plan to upgrade your Flink setup to a more recent version.
+
+See the release notes for [Flink 1.10]({% link release-notes/flink-1.10.md %}), [Flink 1.9]({% link release-notes/flink-1.9.md %}), [Flink 1.8]({% link release-notes/flink-1.8.md %}), or [Flink 1.7]({% link release-notes/flink-1.7.md %}).
+
+</div>
+</div>
-- **Blogs**: The [Apache Flink](https://flink.apache.org/blog/) and [Ververica](https://www.ververica.com/blog) blogs publish frequent, in-depth technical articles about Flink.
[flink] 03/04: [FLINK-17981][docs] Improvements to layout and
content based on reviews
Posted by sj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 308ef5866cb25e87924ef1738a9b20631d90b954
Author: David Anderson <da...@alpinegizmo.com>
AuthorDate: Fri Jun 12 12:08:10 2020 +0200
[FLINK-17981][docs] Improvements to layout and content based on reviews
---
docs/index.md | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 2493c1a..bc96733 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -23,16 +23,16 @@ specific language governing permissions and limitations
under the License.
-->
-This documentation is for Apache Flink version {{ site.version_title }}. These pages were built at: {% build_time %}.
+<p style="margin: 30px 60px 0 60px" markdown="1">
+Apache Flink is a framework and distributed processing engine for stateful computations over _unbounded and bounded_ data streams. Flink has been designed to run in _all common cluster environments_, perform computations at _in-memory speed_ and at _any scale_.
+</p>
<div class="row">
<div class="col-sm-6" markdown="1">
### Try Flink
-Apache Flink is an open source platform with expressive APIs for defining stream and batch data processing jobs, and a robust and scalable engine for executing those jobs.
-
-To quickly get a general understanding of how Flink works and what it offers for your use case, work your way through one of these tutorials:
+If you’re interested in playing around with Flink, try one of our tutorials:
* [Fraud Detection with the DataStream API]({% link try-flink/datastream_api.md %})
* [Real Time Reporting with the Table API]({% link try-flink/table_api.md %})
@@ -41,7 +41,7 @@ To quickly get a general understanding of how Flink works and what it offers for
### Learn Flink
-* Our [Self-paced Training Course]({% link learn-flink/index.md %}) includes a set of lessons and hands-on exercises that provide a step-by-step introduction to Flink.
+* To dive in deeper, the [Hands-on Training]({% link learn-flink/index.md %}) includes a set of lessons and exercises that provide a step-by-step introduction to Flink.
* The [Concepts]({% link concepts/index.md %}) section explains what you need to know about Flink before exploring the reference documentation.
@@ -75,10 +75,15 @@ Before putting your Flink job into production, read the [Production Readiness Ch
### Upgrade Flink
-Release notes cover important changes between Flink versions. Please read them carefully if you plan to upgrade your Flink setup to a more recent version.
+Release notes cover important changes between Flink versions. Please read them carefully if you plan to upgrade your Flink setup.
See the release notes for [Flink 1.10]({% link release-notes/flink-1.10.md %}), [Flink 1.9]({% link release-notes/flink-1.9.md %}), [Flink 1.8]({% link release-notes/flink-1.8.md %}), or [Flink 1.7]({% link release-notes/flink-1.7.md %}).
</div>
</div>
+<div style="margin: 40px 0 0 0; position: relative; top: 20px;">
+<p>
+This documentation is for Apache Flink version {{ site.version_title }}. These pages were built at: {% build_time %}.
+</p>
+</div>
\ No newline at end of file