Green-Software-Foundation / if

Impact Framework
https://if.greensoftware.foundation/
MIT License
130 stars 36 forks source link

Rename `csv-export` plugin to `grafana-exporter` #670

Closed jmcook1186 closed 4 weeks ago

jmcook1186 commented 1 month ago

What Rename the current csv-exporter plugin (NOT the builtin csv exporter - only the plugin in if-plugins to grafana-exporter

Why We currently have a pair of csv export features - one is a builtin feature that exports a general purpose, more human readable CSV file for a given metric. The other is a plugin that exports a CSV representation of the tree in a format that works well as a data source for grafana visualizations. It is not obvious to users which one to use, especially because there is csv-specific config in a manifest and it can be very confusing which config refers to which plugin. Longer term, we will want to implement a more robust solution to this problem, likely involving a new standard for export features, but for now we can ease the situation substantially with a simple name change. This will enable users to quickly distinguish the CSV export they really want and enable easier separation of config in manifest files.

Context This was stimulated by the following bug report: https://github.com/Green-Software-Foundation/if-plugins/issues/78

Prerequisites/resources None

SoW (scope of work)

Acceptance criteria

jmcook1186 commented 1 month ago

Code, tests and readme changes are in https://github.com/Green-Software-Foundation/if-plugins/pull/86 if-docs updates are in https://github.com/Green-Software-Foundation/if-docs/pull/70

zanete commented 1 month ago

Capturing the status in the weekly call: @narekhovhannisyan could review