From 19b3a09bf7ebc095770d06605379655edd413f3d Mon Sep 17 00:00:00 2001 From: Derek Wang Date: Wed, 7 Sep 2022 09:14:17 -0700 Subject: [PATCH] docs: home page for doc site Signed-off-by: Derek Wang --- docs/README.md | 25 ++++++++++++++++++ .../numaflow-ui-simple-pipeline.png | Bin docs/quick-start.md | 2 +- 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/README.md rename docs/{ => assets}/numaflow-ui-simple-pipeline.png (100%) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..caaa084808 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,25 @@ +# Numaflow + +Numaflow is a Kubernetes-native platform for running massive 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. + +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) diff --git a/docs/numaflow-ui-simple-pipeline.png b/docs/assets/numaflow-ui-simple-pipeline.png similarity index 100% rename from docs/numaflow-ui-simple-pipeline.png rename to docs/assets/numaflow-ui-simple-pipeline.png diff --git a/docs/quick-start.md b/docs/quick-start.md index 941dd9b138..e98660a745 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -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 ``` -numaflo-ui +![Numaflow UI](assets/numaflow-ui-simple-pipeline.png) The pipeline can be deleted by ```shell