search

Green-Software-Foundation / if-plugins

Impact Framework models owned and maintained by the GSF
MIT License
24 stars 17 forks source link

Move grafana export plugin to self hosted repository and register in the Plugin Registery #95

Closed perkss closed 2 months ago

perkss commented 5 months ago

Rationale

With the deprecation of if-plugins we are required to move the grafana-exporter.

Implementation details

Priority

2

Scope

N/A

Size

6

What does "done" look like?

Plugin removed from this repository, hosted by @perkss and registered in plugin registry

Does this require updates to documentation or other materials??

Only applicable in this code

Deadline

Acceptance criteria

Plugin code copied into new repository and then this code can be removed https://github.com/Green-Software-Foundation/if-plugin-website?tab=readme-ov-file#plugin-governance

perkss commented 5 months ago

@jmcook1186 can you assign this to me please?

jmcook1186 commented 5 months ago

sure - thanks @perkss also added it to the IF project board just so we can keep track

jmcook1186 commented 5 months ago

You can just add a deprecation notice to the if-plugins version for now instead of actually removing anything from if-plugins. That way we don't break anything before we've had time to warn our users and give some grace period. @perkss

perkss commented 5 months ago

New plugin repo: https://github.com/perkss/grafana-export

perkss commented 4 months ago

@jmcook1186 do you have an example of the deprecation notice to put? Or the style I should use? Just in the docstring like this: https://jsdoc.app/tags-deprecated?

jmcook1186 commented 4 months ago

@perkss You can just add the following in bold to the top of the README in if-plugins

THIS PLUGIN IS DEPRECATED. IT IS NOW BEING MAINTAINED IN < link-to-your-repo >. THE VERSION IN THIS REPOSITORY IS NO LONGER BEING ACTIVELY MAINTAINED AND IS SCHEDULED TO BE DELETED BEFORE JULY 2024.