microsoft / carbon-aware-sdk

Carbon-Aware Core SDK

MIT License

14 stars 8 forks source link

Azure API Management Sample #246

Open JenMadiedo opened 1 year ago

JenMadiedo commented 1 year ago

User Story

As an Azure APIM user, I want to be able to connect to the carbon aware SDK from my policy to make my implementation carbon aware.

Design Goals

Provide an example of how users can integrate the carbon aware SDK into APIM
Provide an example policy that uses the carbon aware SDK to make decisions about routing.

Task List

[ ] Add policy samples
[ ] Add readme docs

Acceptance Criteria

[ ] GettingStarted.md no longer exists in the root directory
[ ] User have a clear guide for starting out with the SDK
[ ] All unique pieces of information from the original GettingStarted.md can be found somewhere in /docs
[ ] Content touched is markdown-lint compliant

juzuluag commented 1 year ago

PR: Green-Software-Foundation/carbon-aware-sdk#257