numaflow
numaflow copied to clipboard
Documentation Feedback Improvements for Numaflow
Here are some feedback that we should consider for the documentation we have currently for NumaFlow .
- We should follow the basic structure in https://github.com/argoproj/argo-workflows -Which provides uber level description of why we build Numaflow and pointers to location of documentation which includes the Quickstart.
- We should add capability matrix
- We should have a section that shares the point of view as to when users should use argo workflow versus numa
- All examples documented needs to have the following criteria - how to set pipeline up, how to pump data into pipeline, how to view the results , how to validate the results
- More details around how to create UDF and enabling it in the pipeline
- There needs to be a hook between setting the pipeline and viewing the pipeline in the UI