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

Documentation Feedback Improvements for Numaflow #49

Open
malinamfong opened this issue Jun 7, 2022 · 0 comments
Open

Documentation Feedback Improvements for Numaflow #49

malinamfong opened this issue Jun 7, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@malinamfong
Copy link
Collaborator

malinamfong commented Jun 7, 2022

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
@malinamfong malinamfong added the enhancement New feature or request label Jun 7, 2022
@vigith vigith changed the title Documentation Feedback Improvements for Numa Documentation Feedback Improvements for Numaflow Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant