Improve plugin documentation

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.

https://kedro.org

Apache License 2.0

9.49k stars 874 forks source link

Improve plugin documentation #1539

Open merelcht opened 2 years ago

merelcht commented 2 years ago

Description

As has been, amongst others, reported here https://github.com/kedro-org/kedro/issues/779, our documentation doesn't really describe properly how to create plugins for Kedro. Plugin developers need to know Kedro internals very well to know how to access Kedro objects.

To do:

Add docs that describe the plugin developer workflow
Include examples and specifically more complex examples on how to create kedro plugins and access required objects.

stichbury commented 1 year ago

My view with this is that it is quite an advanced topic? Something we should do ourselves (in the team) for a first draft of docs and then potentially a content writer could write a blog post about this.

stichbury commented 9 months ago

Adding this to the upcoming sprint because Merel has just done a great presentation on this and we can use the content to improve what we have. This could become a parent ticket as there are several activities, including one child already #3053