Green-Software-Foundation/carbon-aware-sdk

Define our 'value add' in our documentation

Opened this issue · 2 comments

Why use the CA SDK and not the electricity maps/watttime APIs directly?

This Q came up in the last Opensource Working Group call, and I (who's close to the project) don't even feel clear on the answer.
Making this glaringly obvious in our docs and sharing in gsf-wide newsletter might help us gain new adopters.

Notes from a quick chat with @danuw on this topic

  1. Coverage

The SDK allows for quicker changing between data sources eg. WattTime and ElectricityMaps, than developing and maintaining a separate integration for each API data provider.
The SDK also allows you to add your own data sources.

  1. Standardised access

Get started quicker - no need to be own broker of the APIs.
We handle the upgrades, so users only need to change credentials / endpoints?

  1. Benefit from other users past experiences of the data source APIs. De-duplicate efforts.

Discussion on 21st May
We found it in our docs - https://carbon-aware-sdk.greensoftware.foundation/docs/overview
What does the SDK/API provide that 3rd party data providers such as WattTime or ElectricityMaps do not?
But we agreed this could be punchier, and we could surface this on the website front page update the website front page where the 4 pictures of dinosaurs are.

Discussion on 28th May
to do:

  • Update the front page of our documentation