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.

Sign up for GitHub

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

Jump to bottom

[FEATURE]: Prepare user documentation #66

Open

1 task done

gergo-databricks opened this issue Nov 8, 2024 · 0 comments

Open

1 task done

[FEATURE]: Prepare user documentation #66

gergo-databricks opened this issue Nov 8, 2024 · 0 comments

Labels

gergo-databricks commented Nov 8, 2024

Is there an existing issue for this?

I have searched the existing issues

Problem statement

Users need a detailed guide on how to use the framework.

Proposed Solution

Write two documentations based on the different user personas:

End users who define quality rules on the data using existing checks
End users who develop new quality checks

The README already covers some of it. Let's consider how we can improve it or adapt it to the different personas.

Additional Context

No response

gergo-databricks added the enhancement label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment