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

Curate plugins by maintenance activity in Kedro's documentation #2291

Closed
idanov opened this issue Feb 6, 2023 · 9 comments
Closed

Curate plugins by maintenance activity in Kedro's documentation #2291

idanov opened this issue Feb 6, 2023 · 9 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@idanov
Copy link
Member

idanov commented Feb 6, 2023

Description

Currently Kedro lists a number of community plugins in its documentation (https://kedro.readthedocs.io/en/stable/extend_kedro/plugins.html) , but it's hard to assess how actively maintained those plugins are currently. It would be really useful for the users to have a badge against each plugin on that list with the activity of that plugin, e.g. either commits per month or last commit activity badges.

Context

Why is this change important to you? How would you use it? How can it benefit other users?

Possible Implementation

We can use any of these badges: https://shields.io/category/activity

Last commit Plugin
GitHub last commit kedro-pandas-profiling
GitHub last commit kedro-mlflow
GitHub last commit find-kedro
GitHub last commit kedro-kubeflow
GitHub last commit kedro-airflow-k8s
GitHub last commit kedro-vertexai
GitHub last commit kedro-azureml

And so on...

Additionally, we could ensure the links open in a new tab, since currently they open in the same tab of the documentation.

@idanov idanov added Component: Documentation 📄 Issue/PR for markdown and API documentation Type: Technical DR 💾 Decision Records (technical decisions made) labels Feb 6, 2023
@stichbury
Copy link
Contributor

This is a nice idea, but I'm not sure we can open in a new tab that easily in Sphinx, nor how we'd include these as a table (except perhaps by embedding as HTML within the markdown). It's easy enough to experiment though.

Perhaps it would be preferable to ask active plugin owners to put the badge in their readme and for any that do not, we remove from the list of plugins in a known state and have a separate list of "Use at your peril" plugins in the docs.

@merelcht merelcht changed the title Add GitHub activity badges to the plugins list in Kedro's documentation Curate plugins by maintenance activity in Kedro's documentation Mar 13, 2023
@merelcht
Copy link
Member

merelcht commented Mar 13, 2023

The idea of badges is nice, but it's not clear how this would actually work inside the Sphinx docs. As an alternative solutions we'll go through all the plugins and divide them into "actively maintained" and "unknown state". Presumably users would create a PR if their plugin is in the wrong category.

It's not ideal that this division needs to be maintained manually, but at least it's better than not having the categories at all.

@merelcht merelcht removed the Type: Technical DR 💾 Decision Records (technical decisions made) label Mar 13, 2023
@astrojuanlu
Copy link
Member

@astrojuanlu
Copy link
Member

cc @inigohidalgo

@astrojuanlu
Copy link
Member

@astrojuanlu
Copy link
Member

In summary: I think it's not enough that we put a colored badge depending on activity. Users have showed concerns about whether plugins not under kedro-org are worth adopting (see example), and we should draft a strategy to address those concerns.

This is a huge topic that would deserve some discussion, but off the top of my head and just to start scratching the surface, one thing that could be more valuable than "days since last commit" would be: "does this plugin actually work with the latest versions of Kedro"? Hence providing a compatibility matrix. Something similar to what the Numba folks started here https://github.com/numba/numba-integration-testing

@astrojuanlu
Copy link
Member

@noklam
Copy link
Contributor

noklam commented Jun 27, 2023

Tangentially related kedro-org/kedro-plugins#535

@merelcht
Copy link
Member

I looked at this issue again today and indeed implementing a readable table with badges in sphinx is not trivial at all. I also agree that latest commit is not informative enough. I vote for closing this specific issue and instead, as part of the ongoing deployment work, discuss our support & promotion model for third-party plugins.

@merelcht merelcht removed the Hacktoberfest Issue suitable for hacktoberfest label Nov 7, 2024
@merelcht merelcht closed this as not planned Won't fix, can't repro, duplicate, stale Nov 7, 2024
@github-project-automation github-project-automation bot moved this from To Do to Done in Kedro Framework Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Status: Todo
Development

No branches or pull requests

5 participants