You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tz...@apache.org on 2020/03/12 02:45:46 UTC
[flink-statefun] 01/08: [FLINK-16515][docs] Drop contribute and
roadmap pages
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 267d3160f9ead031e3eb5162fb8270aece5060d1
Author: Seth Wiesman <sj...@gmail.com>
AuthorDate: Wed Mar 4 18:07:56 2020 -0600
[FLINK-16515][docs] Drop contribute and roadmap pages
---
statefun-docs/docs/contribute.rst | 24 ---------------
statefun-docs/docs/index.rst | 5 ++--
statefun-docs/docs/overview/index.rst | 4 +--
statefun-docs/docs/roadmap.rst | 56 -----------------------------------
4 files changed, 4 insertions(+), 85 deletions(-)
diff --git a/statefun-docs/docs/contribute.rst b/statefun-docs/docs/contribute.rst
deleted file mode 100644
index fc98d82..0000000
--- a/statefun-docs/docs/contribute.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. _contribute:
-
-#################
-How to Contribute
-#################
-
-**Stateful Functions** is an open source project. Developing in an open community, in close collaboration with real people solving real problems is, for us, the best way to learn and grow.
-
-If you find these ideas interesting or promising, try **Stateful Functions** out, explore the code and get involved! We strongly encourage you to file an issue or open a pull request on `GitHub <https://github.com/apache/flink-statefun>`_!
\ No newline at end of file
diff --git a/statefun-docs/docs/index.rst b/statefun-docs/docs/index.rst
index 6feab78..28a30f0 100644
--- a/statefun-docs/docs/index.rst
+++ b/statefun-docs/docs/index.rst
@@ -18,10 +18,9 @@
overview/index
getting_started/index
+ concepts/index
api_concepts/index
deployment_operations/index
- roadmap
- contribute
###########################################
Lightweight, Stateful Applications at Scale
@@ -34,4 +33,4 @@ Lightweight, Stateful Applications at Scale
:align: center
.. raw:: html
- :file: index_grid.html
\ No newline at end of file
+ :file: index_grid.html
diff --git a/statefun-docs/docs/overview/index.rst b/statefun-docs/docs/overview/index.rst
index 061fae9..6fbeebe 100644
--- a/statefun-docs/docs/overview/index.rst
+++ b/statefun-docs/docs/overview/index.rst
@@ -62,9 +62,9 @@ Technology Space
**Stateful Functions** is heavily inspired by multiple existing technologies for stateless application development and orchestration. Other than Apache Flink, also Function-as-a-Service (FaaS) systems such as AWS Lambda and the `virtual stateful actor model <https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/Orleans-MSR-TR-2014-41.pdf>`_ from Microsoft Orleans served as inspiration for this project.
-The framework is mostly implemented in Java and runs on the JVM. Extending the API to be cross-language compatible and support languages like Python, Go or NodeJS is part of the :ref:`Roadmap <roadmap>`.
+The framework is mostly implemented in Java and runs on the JVM. Extending the API to be cross-language compatible and support languages like Python, Go or NodeJS is part of the Roadmap.
Get Involved!
#############
-If you find these ideas interesting, give **Stateful Functions** a try and get involved! Check out the :ref:`Getting Started <getting_started_example>` section for introduction walkthroughs. File an issue if you have an idea how to improve things.
\ No newline at end of file
+If you find these ideas interesting, give **Stateful Functions** a try and get involved! Check out the :ref:`Getting Started <getting_started_example>` section for introduction walkthroughs. File an issue if you have an idea how to improve things.
diff --git a/statefun-docs/docs/roadmap.rst b/statefun-docs/docs/roadmap.rst
deleted file mode 100644
index a376d16..0000000
--- a/statefun-docs/docs/roadmap.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. _roadmap:
-
-#######################
-Roadmap and Future Work
-#######################
-
-.. contents:: :local:
-
-Project Community
-=================
-
-We plan to contribute the Stateful Functions project to the Apache Flink project, to continue to develop it in an open-source and open-community way. We believe that developing this is the best way to grow the project, with an open community of users and contributors.
-
-The Apache Flink community is a natural fit, because Stateful Functions currently builds on top of Apache Flink, and because the problems it solves are connected to event-driven applications and stream processing.
-
-However, the decision whether to accept this project as a contribution ultimately rests with the Flink community. We are in touch with the Flink community, stay tuned for updates.
-
-Features
-========
-
-The project is a work-in-progress. We believe we are off to a promising direction, but there is still a way to go to make all parts of this vision a reality. There are many possible ways to enhance **Stateful Functions** for different types of applications. Possibilities for enhancements to the runtime and operations will also evolve with the evolution of capabilities of Apache Flink. The following features are on our short-term Roadmap:
-
-Non-JVM languages / Polyglot Functions
-######################################
-
-We plan to support other languages as well, like Python, or Go. The exact design is still open, but current ideas center around running functions in separate containers next to the JVM. See `this <https://cwiki.apache.org/confluence/display/FLINK/FLIP-38%3A+Python+Table+API>`_ design proposal describing how Apache Flink and Apache Beam approach that problem.
-
-Stronger-typed APIs
-###################
-
-As is, the stateful functions abstraction accepts untyped objects as messages. We plan to add a stronger-typed API and tools to more easily implement complex behaviors and interaction protocols between multiple functions.
-
-Time-to-live (TTL) for Functions
-################################
-
-Logical function instances and their state live until they are explicitly dropped (i.e. cleared). TTL would support automatically dropping function instances that have not been messaged for a defined amount of time. Apache Flink’s state TTL feature can back this efficiently, by piggybacking on the RocksDB compaction mechanism to delete expired functions in the background.
-
-Dynamic loading and unloading of Functions
-##########################################
-
-Dynamic loading of functions will support adding new functions and routers to a running cluster without disruption. This can form the backbone for update strategies or for users to build a “StatefulFunctions-as-a-Service”-style abstraction on top of this project.