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

Datasource Selection Documentation #216

Merged

Conversation

JenMadiedo
Copy link
Contributor

@JenMadiedo JenMadiedo commented Dec 13, 2022

Issue Number: (Link to Github Issue or Azure Dev Ops Task/Story)

DEPENDENT PR

Warning
This PR depends on commits in other PRs
DO NOT merge this PR until #203 is merged and this branch is updated against the latest dev branch

Use THIS LINK to review only the code for this PR and hide the dependent commits

Summary

Add a doc that details the different configs/access patterns of the various data sources.

Changes

  • Add doc

Checklist

  • Local Tests Passing?
  • CICD and Pipeline Tests Passing?
  • Added any new Tests?
  • Documentation Updates Made?
  • Are there any API Changes? If yes, please describe below.
  • This is not a breaking change. If it is, please describe it below.

This PR Closes #<issue_number>

@codecov-commenter
Copy link

Codecov Report

Merging #216 (c859b7b) into dev (bab7550) will decrease coverage by 5.55%.
The diff coverage is 57.45%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev     #216      +/-   ##
==========================================
- Coverage   82.23%   76.68%   -5.56%     
==========================================
  Files          66       77      +11     
  Lines        2055     2616     +561     
  Branches      219      260      +41     
==========================================
+ Hits         1690     2006     +316     
- Misses        313      536     +223     
- Partials       52       74      +22     
Impacted Files Coverage Δ
...yMaps/src/Client/ElectricityMapsClientException.cs 0.00% <0.00%> (ø)
...s/src/Client/ElectricityMapsClientHttpException.cs 0.00% <0.00%> (ø)
...are.DataSources.WattTime/src/WattTimeDataSource.cs 89.78% <ø> (ø)
...rces/src/Exceptions/LocationConversionException.cs 66.66% <ø> (ø)
...ools.WattTimeClient/src/WattTimeClientException.cs 100.00% <ø> (ø)
....WattTimeClient/src/WattTimeClientHttpException.cs 63.63% <ø> (ø)
...c/GSF.CarbonAware/src/Handlers/EmissionsHandler.cs 0.00% <0.00%> (ø)
...rc/GSF.CarbonAware/src/Handlers/ForecastHandler.cs 0.00% <0.00%> (ø)
src/GSF.CarbonAware/src/Models/EmissionsData.cs 0.00% <0.00%> (ø)
...lectricityMaps/src/Client/ElectricityMapsClient.cs 45.61% <45.61%> (ø)
... and 13 more

docs/data-source-matrix.md Outdated Show resolved Hide resolved
docs/data-source-matrix.md Outdated Show resolved Hide resolved
docs/data-source-matrix.md Outdated Show resolved Hide resolved
docs/data-source-matrix.md Outdated Show resolved Hide resolved
docs/data-source-matrix.md Outdated Show resolved Hide resolved
docs/data-source-matrix.md Outdated Show resolved Hide resolved
docs/data-source-matrix.md Outdated Show resolved Hide resolved
@JenMadiedo
Copy link
Contributor Author

@vaughanknight / @Willmish ready for review

@JenMadiedo JenMadiedo changed the title Datasource Matrix Documentation Datasource Selection Documentation Jan 3, 2023
Copy link
Contributor

@bderusha bderusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

docs/selecting-a-data-source.md Outdated Show resolved Hide resolved
docs/selecting-a-data-source.md Outdated Show resolved Hide resolved
docs/selecting-a-data-source.md Outdated Show resolved Hide resolved
Copy link
Contributor

@juzuluag juzuluag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@vaughanknight vaughanknight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update and thanks for this. It's something that's come up a few times and we had discussed last week someone left a bug because they didn't know how to configure, when everything was actually working as intended... just not how they expected or were aware. Big thanks.

@vaughanknight vaughanknight merged commit 4ee5b41 into Green-Software-Foundation:dev Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants