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

docs: add homepage of https://numaflow.numaproj.io/ #163

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
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
25 changes: 25 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Numaflow
Copy link
Member Author

@whynowy whynowy Sep 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edlee2121 - we need this file as it's the homepage of https://numaflow.numaproj.io/.

Please suggest the content.


Numaflow is a Kubernetes-native platform for running massive parallel data processing and streaming jobs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Numaflow is a Kubernetes-native platform for running massive parallel data processing and streaming jobs.
Numaflow is a Kubernetes-native platform for running massively parallel data processing and streaming jobs.


A Numaflow Pipeline is implemented as a Kubernetes custom resource, and consists of one or more source, data processing, and sink vertices.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A Numaflow Pipeline is implemented as a Kubernetes custom resource, and consists of one or more source, data processing, and sink vertices.
A Numaflow Pipeline is implemented as a Kubernetes custom resource and consists of a source vertex, multiple data processing vertices, and sink vertices.


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

## Key Features

- Kubernetes-native: If you know Kubernetes, you already know 90% of what you need to use Numaflow.
- Language agnostic: Use your favorite programming language.
- Exactly-Once semantics: No input element is duplicated or lost even as pods are rescheduled or restarted.
- Auto-scaling with back-pressure: Each vertex automatically scales from zero to whatever is needed.

## Roadmap

- Data aggregation (e.g. group-by)

## Resources

- [QUICK_START](quick-start.md)
- [EXAMPLES](https://github.com/numaproj/numaflow/tree/main/examples)
- [DEVELOPMENT](development.md)
- [CONTRIBUTING](https://github.com/numaproj/numaproj/blob/main/CONTRIBUTING.md)
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ kubectl logs -f simple-pipeline-out-0-xxxx main
# Port forward the UI to https://localhost:8443/
kubectl -n numaflow-system port-forward deployment/numaflow-server 8443:8443
```
<img src="numaflow-ui-simple-pipeline.png" alt="numaflo-ui" width="650"/>
![Numaflow UI](assets/numaflow-ui-simple-pipeline.png)

The pipeline can be deleted by
```shell
Expand Down