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/26 14:21:23 UTC
[flink-statefun] 11/14: [FLINK-16758][docs] Update branding
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch release-2.0
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit ff041c42013f6f7a9665cd20d66172f2c732afd1
Author: Seth Wiesman <sj...@gmail.com>
AuthorDate: Wed Mar 25 08:54:11 2020 -0500
[FLINK-16758][docs] Update branding
This closes #73.
---
docs/README.md | 4 +-
docs/_config.yml | 4 +-
docs/_includes/sidenav.html | 2 +-
docs/_layouts/base.html | 10 +-
docs/getting-started/walkthrough.md | 2 +-
docs/index.md | 4 +-
docs/io-module/flink-connectors.md | 4 +-
docs/page/favicon.ico | Bin 1150 -> 0 bytes
docs/page/favicon.png | Bin 0 -> 61427 bytes
docs/page/img/navbar-brand-logo.jpg | Bin 18470 -> 0 bytes
docs/page/img/navbar-brand-logo.png | Bin 0 -> 57778 bytes
statefun-docs/docs/conf.py | 231 ------------------------------------
statefun-docs/pom.xml | 148 -----------------------
13 files changed, 14 insertions(+), 395 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index c3d5f63..78c8a47 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,6 @@
-This README gives an overview of how to build and contribute to the documentation of Apache Flink.
+This README gives an overview of how to build and contribute to the documentation of Apache Flink Stateful Functions.
-The documentation is included with the source of Apache Flink in order to ensure that you always
+The documentation is included with the source of Apache Flink Stateful Functions in order to ensure that you always
have docs corresponding to your checked out version. The online documentation at
https://flink.apache.org/ is also generated from the files found here.
diff --git a/docs/_config.yml b/docs/_config.yml
index bc4177f..a92921a 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -27,10 +27,10 @@
# we change the version for the complete docs when forking of a release branch
# etc.
# The full version string as referenced in Maven (e.g. 1.2.1)
-version: "2.0-SNAPSHOT"
+version: "2.1-SNAPSHOT"
# For stable releases, leave the bugfix version out (e.g. 1.2). For snapshot
# release this should be the same as the regular version
-version_title: "2.0-SNAPSHOT"
+version_title: "2.1-SNAPSHOT"
# Branch on Github for this version
github_branch: "master"
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
index 4697a9f..4c10ebd 100644
--- a/docs/_includes/sidenav.html
+++ b/docs/_includes/sidenav.html
@@ -80,7 +80,7 @@ level is determined by 'nav-pos'.
{%- assign pos = 0 -%}
<div class="sidenav-logo">
- <p><a href="{{ baseurl_i18n }}/"><img class="bottom" alt="Apache Flink" src="{{ site.baseurl }}/page/img/navbar-brand-logo.jpg"></a> v{{ site.version_title }}</p>
+ <p><a href="{{ baseurl_i18n }}/"><img class="bottom" alt="Apache Flink" src="{{ site.baseurl }}/page/img/navbar-brand-logo.png"></a> v{{ site.version_title }}</p>
</div>
<ul id="sidenav">
{%- for i in (1..10000) -%}
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 512838a..9ba8cf8 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -23,9 +23,9 @@ under the License.
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
- <title>Apache Flink {{ site.version_title }} Documentation: {{ page.title }}</title>
- <link rel="shortcut icon" href="{{ site.baseurl }}/page/favicon.ico" type="image/x-icon">
- <link rel="icon" href="{{ site.baseurl }}/page/favicon.ico" type="image/x-icon">
+ <title>Apache Flink Stateful Functions {{ site.version_title }} Documentation: {{ page.title }}</title>
+ <link rel="shortcut icon" href="{{ site.baseurl }}/page/favicon.png" type="image/x-icon">
+ <link rel="icon" href="{{ site.baseurl }}/page/favicon.png" type="image/x-icon">
<link rel="canonical" href="{{ site.stable_baseurl }}{{ page.url | replace:'index.html',''}}">
<!-- Bootstrap -->
@@ -58,9 +58,9 @@ under the License.
{% if site.show_outdated_warning %}
<div style="position:fixed; bottom:0; left:0; z-index:99999; width:100%; text-align:center; padding:15px; border-top:5px solid #ECCCD1; background:#F2DEDE; color:#AD433F; font-weight:bold">
{% if page.language == "en" %}
- This documentation is for an out-of-date version of Apache Flink. We recommend you use <a href="https://ci.apache.org/projects/flink/flink-docs-stable/">the latest stable version</a>.
+ This documentation is for an out-of-date version of Apache Flink Stateful Functions. We recommend you use <a href="https://ci.apache.org/projects/flink/flink-statefun-docs-stable/">the latest stable version</a>.
{% else if page.language == "zh" %}
- 本文档是 Apache Flink 的旧版本。建议访问 <a href="https://ci.apache.org/projects/flink/flink-docs-stable/zh">最新的稳定版本</a>。
+ 本文档是 Apache Flink Stateful Functions 的旧版本。建议访问 <a href="https://ci.apache.org/projects/flink/flink-statefun-docs-stable/zh">最新的稳定版本</a>。
{% endif %}
</div>
{% endif %}
diff --git a/docs/getting-started/walkthrough.md b/docs/getting-started/walkthrough.md
index 4c895bd..b55b0a4 100644
--- a/docs/getting-started/walkthrough.md
+++ b/docs/getting-started/walkthrough.md
@@ -169,7 +169,7 @@ public final class GreetFunction implements StatefulFunction {
Each time a message is processed, the function computes a personalized message for that user.
It reads and updates the number of times that user has been seen and sends a greeting to the egress.
-You can check the full code for the application described in this walkthrough `here <{examples}/statefun-greeter-example>`.
+You can check the full code for the application described in this walkthrough [here]({{ site.github_url }}/tree/{{ site.github_branch }}/statefun-examples/statefun-greeter-example).
In particular, take a look at the module ``GreetingModule``, which is the main entry point for the full application, to see how everything gets tied together.
You can run this example locally using the provided Docker setup.
diff --git a/docs/index.md b/docs/index.md
index 3d04c4f..4d25af3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,5 +1,5 @@
---
-title: "Stateful Functions - An Apache Flink® Project"
+title: "Stateful Functions Documentation"
nav-pos: 0
nav-title: '<i class="fa fa-home title" aria-hidden="true"></i> Home'
nav-parent_id: root
@@ -23,8 +23,6 @@ specific language governing permissions and limitations
under the License.
-->
-## A Framework for Stateful Distributed Applications
-
**Stateful Functions** is an open source framework that reduces the complexity of building and orchestrating distributed stateful applications at scale.
It brings together the benefits of stream processing with Apache Flink® and Function-as-a-Service (FaaS) to provide a powerful abstraction for the next generation of event-driven architectures.
diff --git a/docs/io-module/flink-connectors.md b/docs/io-module/flink-connectors.md
index d25e539..dac8c2a 100644
--- a/docs/io-module/flink-connectors.md
+++ b/docs/io-module/flink-connectors.md
@@ -33,7 +33,7 @@ For details details of how to build a custom connector see the official [Apache
## Dependency
-To use the Kafka I/O Module in Java, please include the following dependency in your pom.
+To use a custom Flink connector, please include the following dependency in your pom.
{% highlight xml %}
<dependency>
@@ -92,4 +92,4 @@ public class ModuleWithSinkSpec implements StatefulFunctionModule {
binder.bindEgress(spec);
}
}
-{% endhighlight %}
\ No newline at end of file
+{% endhighlight %}
diff --git a/docs/page/favicon.ico b/docs/page/favicon.ico
deleted file mode 100644
index 34a467a..0000000
Binary files a/docs/page/favicon.ico and /dev/null differ
diff --git a/docs/page/favicon.png b/docs/page/favicon.png
new file mode 100644
index 0000000..000a103
Binary files /dev/null and b/docs/page/favicon.png differ
diff --git a/docs/page/img/navbar-brand-logo.jpg b/docs/page/img/navbar-brand-logo.jpg
deleted file mode 100644
index 5993ee8..0000000
Binary files a/docs/page/img/navbar-brand-logo.jpg and /dev/null differ
diff --git a/docs/page/img/navbar-brand-logo.png b/docs/page/img/navbar-brand-logo.png
new file mode 100644
index 0000000..677c4d7
Binary files /dev/null and b/docs/page/img/navbar-brand-logo.png differ
diff --git a/statefun-docs/docs/conf.py b/statefun-docs/docs/conf.py
deleted file mode 100644
index adc6b71..0000000
--- a/statefun-docs/docs/conf.py
+++ /dev/null
@@ -1,231 +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.
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-import re
-
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-# https://github.com/djungelorm/sphinx-tabs
-extensions = ['sphinx.ext.ifconfig', 'sphinx_tabs.tabs']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
-# The master toctree document.
-master_doc = 'index'
-
-# Warn about broken references
-nitpicky = True
-
-# General information about the project.
-project = u'Stateful Functions'
-copyright = u'2019, The Apache Software Foundation.'
-author = u'The Apache Flink authors.'
-
-# Render it manually in the footer.html
-html_show_copyright = False
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = u'2.0-SNAPSHOT'
-# The full version, including alpha/beta/rc tags.
-release = u'2.0.0'
-# The latest Flink version supported by Stateful Functions
-flinkVersion = u'1.10'
-# The latest full Flink version supported by Stateful Functions
-flinkRelease = u'1.10.0'
-# The source code repository
-repo = "https://github.com/apache/flink-statefun"
-
-# The examples directory
-example_source = repo + "/tree/master/statefun-examples"
-
-# hide source link
-html_show_sourcelink = False
-# required for the search to work
-html_copy_source = True
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', "hidden"]
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'default'
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_rtd_theme'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#
-html_theme_options = {
- 'titles_only': True,
- 'canonical_url': 'https://statefun.io/',
- 'display_version': False,
- #'prev_next_buttons_location': None
-}
-
-html_show_sphinx = False
-
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
- '**': [
- 'relations.html', # needs 'show_related': True theme option to display
- 'searchbox.html',
- ]
-}
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'StatefulFunctionsdoc'
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- # 'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #
- # 'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #
- # 'preamble': '',
-
- # Latex figure (float) alignment
- #
- # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (master_doc, 'StatefulFunctions.tex', u'Stateful Functions Documentation',
- u'Apache Flink', 'manual'),
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'stateful-functions', u'Stateful Functions Documentation',
- [author], 1)
-]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (master_doc, 'Stateful Functions', u'Stateful Functions Documentation',
- author, 'Stateful Functions', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-# -- Settings for sphinxcontrib-versioning --------------------------------
-scv_greatest_tag = True
-scv_show_banner = True
-scv_banner_greatest_tag = True
-scv_sort = ('semver', 'alpha')
-scv_whitelist_branches = (re.compile(r'^v\d+\.\d+$'),
- re.compile(r'^v\d+\.\d+\.\d+$'),
- 'latest')
-scv_whitelist_tags = (re.compile(r'^v\d+\.\d+$'),
- re.compile(r'^v\d+\.\d+\.\d+$'),
- 'latest')
-
-## Sphynx macros do not work inside of
-## code blocks, so we include these custom
-## replacements to autofill in versions in
-## all places.
-def customReplace(app, docname, source):
- result = source[0]
- for key in app.config.custom_replacements:
- result = result.replace(key, app.config.custom_replacements[key])
- source[0] = result
-
-custom_replacements = {
- "{release}" : release,
- "{version}" : version,
- "{flink}" : u'Apache Flink®',
- "{flinkVersion}" : flinkVersion,
- "{flinkRelease}" : flinkRelease,
- "{repo}" : repo,
- "{examples}" : example_source
-}
-
-def setup(app):
- app.add_config_value('custom_replacements', {}, True)
- app.connect('source-read', customReplace)
diff --git a/statefun-docs/pom.xml b/statefun-docs/pom.xml
deleted file mode 100644
index d97bc05..0000000
--- a/statefun-docs/pom.xml
+++ /dev/null
@@ -1,148 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-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.
--->
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <artifactId>statefun-parent</artifactId>
- <groupId>org.apache.flink</groupId>
- <version>2.0-SNAPSHOT</version>
- </parent>
-
- <artifactId>statefun-docs</artifactId>
- <name>statefun-docs</name>
- <packaging>pom</packaging>
-
- <dependencies>
- <dependency>
- <groupId>org.apache.flink</groupId>
- <artifactId>statefun-sdk</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.flink</groupId>
- <artifactId>statefun-flink-io</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.flink</groupId>
- <artifactId>statefun-kafka-io</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.flink</groupId>
- <artifactId>statefun-kinesis-io</artifactId>
- <version>${project.version}</version>
- </dependency>
- <dependency>
- <groupId>com.fasterxml.jackson.core</groupId>
- <artifactId>jackson-databind</artifactId>
- <version>2.9.6</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>4.12</version>
- <scope>provided</scope>
- </dependency>
- </dependencies>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <version>2.12.4</version>
- <configuration>
- <skipTests>true</skipTests>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jar-plugin</artifactId>
- <version>2.6</version>
- <executions>
- <execution>
- <id>default-jar</id>
- <phase>none</phase>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-install-plugin</artifactId>
- <version>2.5.2</version>
- <executions>
- <execution>
- <id>default-install</id>
- <phase>none</phase>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-deploy-plugin</artifactId>
- <version>2.8.2</version>
- <executions>
- <execution>
- <id>default-deploy</id>
- <phase>none</phase>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>org.apache.rat</groupId>
- <artifactId>apache-rat-plugin</artifactId>
- <version>0.13</version>
- <executions>
- <execution>
- <phase>verify</phase>
- <goals>
- <goal>check</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <excludes>
- <!-- Additional files like .gitignore etc.-->
- <exclude>**/.*/**</exclude>
- <exclude>**/*.prefs</exclude>
- <exclude>**/*.log</exclude>
- <!-- Administrative files in the main trunk. -->
- <exclude>**/README.md</exclude>
- <exclude>.github/**</exclude>
- <!-- Generated content -->
- <exclude>**/target/**</exclude>
- <exclude>**/_build/**</exclude>
- <exclude>requirements.txt</exclude>
- <exclude>runtime.txt</exclude>
- <exclude>/docs/_templates/**</exclude>
- <!-- Generated code -->
- <exclude>**/generated/**</exclude>
- </excludes>
- </configuration>
- </plugin>
- </plugins>
- </build>
-</project>
\ No newline at end of file