From abe332e6d4cc09f3540440de17d9ec6225cf3c21 Mon Sep 17 00:00:00 2001 From: Derek Wang Date: Mon, 11 Sep 2023 16:47:15 -0700 Subject: [PATCH] fix(docs): file names and links for side inputs (#1037) Signed-off-by: Derek Wang --- README.md | 11 +++++------ docs/README.md | 5 ++--- docs/specifications/side-inputs.md | 2 -- .../reference/{sideinputs.md => side-inputs.md} | 0 mkdocs.yml | 4 ++-- 5 files changed, 9 insertions(+), 13 deletions(-) rename docs/user-guide/reference/{sideinputs.md => side-inputs.md} (100%) diff --git a/README.md b/README.md index e82ffb2c95..ff5ec5731a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -37,7 +37,6 @@ full-featured stream processing platforms. ## Roadmap -- JOIN Vertex and Side Inputs feature (v0.10) - User-defined Source (v0.11) ## Demo diff --git a/docs/README.md b/docs/README.md index f29a1cc9a1..5b6f80a8eb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 @@ -29,7 +29,6 @@ stream processing platforms. ## Roadmap -- JOIN Vertex and Side Inputs feature (v0.10) - User-defined Source (v0.11) ## Demo diff --git a/docs/specifications/side-inputs.md b/docs/specifications/side-inputs.md index 16bc04408f..a96b1ea5da 100644 --- a/docs/specifications/side-inputs.md +++ b/docs/specifications/side-inputs.md @@ -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 diff --git a/docs/user-guide/reference/sideinputs.md b/docs/user-guide/reference/side-inputs.md similarity index 100% rename from docs/user-guide/reference/sideinputs.md rename to docs/user-guide/reference/side-inputs.md diff --git a/mkdocs.yml b/mkdocs.yml index 222bb91fd5..07aba485a5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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