Skip to content

Commit

Permalink
fix(docs): file names and links for side inputs (#1037)
Browse files Browse the repository at this point in the history
Signed-off-by: Derek Wang <[email protected]>
  • Loading branch information
whynowy authored Sep 11, 2023
1 parent 20fb7cc commit abe332e
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 13 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@

## Summary

Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented
Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented
as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices.

Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a
Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a
full-featured stream processing platforms.

## Use Cases

- Real-time data analytics applications.
- Event driven applications such as anomaly detection, monitoring, and alerting.
- Streaming applications such as data instrumentation and data movement.
- Real-time data analytics applications.
- Event driven applications such as anomaly detection, monitoring, and alerting.
- Streaming applications such as data instrumentation and data movement.
- Workflows running in a streaming manner.

## Key Features
Expand All @@ -37,7 +37,6 @@ full-featured stream processing platforms.

## Roadmap

- JOIN Vertex and Side Inputs feature (v0.10)
- User-defined Source (v0.11)

## Demo
Expand Down
5 changes: 2 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Numaflow

Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented
Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented
as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices.

Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a full-featured
Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a full-featured
stream processing platforms.

## Use Cases
Expand All @@ -29,7 +29,6 @@ stream processing platforms.

## Roadmap

- JOIN Vertex and Side Inputs feature (v0.10)
- User-defined Source (v0.11)

## Demo
Expand Down
2 changes: 0 additions & 2 deletions docs/specifications/side-inputs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Side Inputs

![Proposal](../assets/proposal.svg)

Side Inputs allow the user defined functions (including UDF, UDSink, Transformer, etc.) to access slow updated data or configuration (such as database, file system, etc.) without needing to load it during each message processing. Side Inputs are read-only and can be used in both batch and streaming jobs.

## Requirements
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ nav:
- user-guide/reference/conditional-forwarding.md
- user-guide/reference/join-vertex.md
- user-guide/reference/multi-partition.md
- user-guide/reference/sideinputs.md
- user-guide/reference/side-inputs.md
- Configuration:
- user-guide/reference/configuration/container-resources.md
- user-guide/reference/configuration/volumes.md
Expand Down Expand Up @@ -119,7 +119,7 @@ nav:
- specifications/controllers.md
- specifications/autoscaling.md
- Edges, Buffers and Buckets: "specifications/edges-buffers-buckets.md"
- Side Inputes: "specifications/side-inputs.md"
- Side Inputs: "specifications/side-inputs.md"
- development/debugging.md
- development/static-code-analysis.md
- development/releasing.md
Expand Down

0 comments on commit abe332e

Please sign in to comment.