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

Issue 479: Support Docusaurus format #594

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
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
Next Next commit
Move Markdown titles to front matter
  • Loading branch information
Claudio Fahey authored and derekm committed Nov 12, 2021
commit c536a0e3bf4b538c2f062ecf9a25630e7d2d8af9
6 changes: 4 additions & 2 deletions documentation/src/docs/batch.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Batch
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Batch Connector

The Flink Connector library for Pravega makes it possible to use a Pravega Stream as a data source and data sink in a batch program. See the below sections for details.

## Table of Contents
6 changes: 4 additions & 2 deletions documentation/src/docs/configurations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Configurations
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Configurations

The Flink connector library for Pravega supports the **Flink Streaming API**, **Table API** and **Batch API**, using a common configuration class.

## Table of Contents
4 changes: 4 additions & 0 deletions documentation/src/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Getting Started
---

<!--
Copyright Pravega Authors.

6 changes: 4 additions & 2 deletions documentation/src/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Overview
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Apache Flink Connectors for Pravega

This documentation describes the connectors API and it's usage to read and write [Pravega](http://pravega.io/) streams with [Apache Flink](http://flink.apache.org/) stream processing framework.

Build end-to-end stream processing pipelines that use Pravega as the stream storage and message bus, and Apache Flink for computation over the streams. See the [Pravega Concepts](http://pravega.io/docs/pravega-concepts/) page for more information.
6 changes: 4 additions & 2 deletions documentation/src/docs/metrics.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Metrics
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Metrics

Pravega metrics are collected and exposed via Flink metrics framework when using [`FlinkPravegaReader`](streaming.md#flinkpravegareader) or [`FlinkPravegaWriter`](streaming.md#flinkpravegawriter).

## Reader Metrics
6 changes: 4 additions & 2 deletions documentation/src/docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Quick Start
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Getting Started

## Creating a Flink Stream Processing Project

**Note**: _You can skip this step if you have a streaming project set up already._
6 changes: 4 additions & 2 deletions documentation/src/docs/serialization.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Serialization
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Serialization

**Serialization** refers to converting a data element in your Flink program to/from a message in a Pravega stream.

Flink defines a standard interface for data serialization to/from byte messages delivered by various connectors. The core interfaces are:
6 changes: 4 additions & 2 deletions documentation/src/docs/streaming.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Streaming
---

<!--
Copyright Pravega Authors.

@@ -14,8 +18,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Streaming Connector

The Flink Connector library for Pravega provides a data source and data sink
for use with the Flink Streaming API. See the below sections for details.