Skip to content

Commit 4cece7b

Browse files
committed
Link fixes (may be related to latest version now erroring)
1 parent b7483b6 commit 4cece7b

File tree

16 files changed

+2143
-2120
lines changed

16 files changed

+2143
-2120
lines changed

casdk-docs/docs/architecture/c-sharp-client-library.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ To do the override, define a class that inherits from
135135
CarbonAwareParametersBaseDTO and uses the [FromQuery(Name =
136136
"myAwesomeDisplayName")] or [JsonPropertyName("myAwesomeDisplayName")]
137137
attribute. A second (less recommended) option is to pass the optional arg
138-
Dictionary<string, string>? displayNameMap when you are directly creating the
138+
`Dictionary<string, string>? displayNameMap` when you are directly creating the
139139
object. With either option, the SDK handles updating references internally.
140140

141141
### Required Properties
@@ -212,4 +212,4 @@ as part of error reporting.
212212

213213
## References
214214

215-
<https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/>
215+
[https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/)

casdk-docs/docs/architecture/data-sources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ of, that client.
2828
processed the request, and then processes the response before returning a
2929
final result.
3030

31-
### GSF Handler <-> Data Source Contract
31+
### GSF Handler < - > Data Source Contract
3232

3333
In order for the SDK to support different data sources, there is a defined
3434
contract between the Handler and the Data tier. The handler acts as the

casdk-docs/docs/architecture/decisions/0001-record-architecture-decisions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We need to record the architectural decisions made on this project.
1212

1313
We will use Architecture Decision Records, as described by Michael Nygard in
1414
this article:
15-
<http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions>
15+
[http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)
1616

1717
## Consequences
1818

casdk-docs/docs/architecture/decisions/0011-cd-pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ Neutral
5454

5555
## References
5656

57-
- <https://github.com/Green-Software-Foundation/carbon-aware-sdk/discussions/46>
57+
- [https://github.com/Green-Software-Foundation/carbon-aware-sdk/discussions/46](https://github.com/Green-Software-Foundation/carbon-aware-sdk/discussions/46)
5858
- [GitHub Packages](https://github.com/features/packages)
5959
- [GitHub Actions](https://github.com/features/actions)

casdk-docs/docs/architecture/decisions/0012-electricity-maps-free.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Approved
66
## Context
77
Electricity Maps offers two different services:
88
- the paid one, which has already been added to the dev branch of the Carbon Aware SDK,
9-
- and the free one, which they also call "CO2 Signal" (<https://www.co2signal.com/>), which the Carbon Aware SDK already supports in a [branch](https://github.com/Green-Software-Foundation/carbon-aware-sdk/tree/feat/electricity-map), though it is based on an older, now outdated version of the SDK.
9+
- and the free one, which they also call "CO2 Signal" ([https://www.co2signal.com/](https://www.co2signal.com/)), which the Carbon Aware SDK already supports in a [branch](https://github.com/Green-Software-Foundation/carbon-aware-sdk/tree/feat/electricity-map), though it is based on an older, now outdated version of the SDK.
1010

1111
These two services, despite being provided by the same company, use different APIs. The free API isn't just a subset of the paid one: **the endpoints are different, the tokens are different, and the responses are different**. Here's an example of two equivalent calls to these services, getting the latest value for the Carbon Intensity in France:
1212

1313
- ElectricityMaps free (CO2 Signal):
14-
- Documentation: <https://docs.co2signal.com/>
14+
- Documentation: [https://docs.co2signal.com/](https://docs.co2signal.com/)
1515
- Request:
1616

1717
`curl -s 'https://api.co2signal.com/v1/latest?countryCode=FR' -H 'auth-token: myapitoken'`
1818

1919
- Response:
20-
20+
```json
2121
{
2222
"_disclaimer": "This data is the exclusive property of Electricity Maps and/or related parties. If you're in doubt about your rights to use this data, please contact [email protected]",
2323
"status": "ok",
@@ -31,16 +31,16 @@ These two services, despite being provided by the same company, use different AP
3131
"carbonIntensity": "gCO2eq/kWh"
3232
}
3333
}
34-
34+
```
3535

3636
- ElectricityMaps paid:
37-
- Documentation: <https://static.electricitymaps.com/api/docs/index.html>
37+
- Documentation: [https://static.electricitymaps.com/api/docs/index.html](https://static.electricitymaps.com/api/docs/index.html)
3838
- Request:
3939

4040
`curl -s 'https://api.electricitymap.org/v3/carbon-intensity/latest?zone=FR' -H 'auth-token: myapitoken'`
4141

4242
- Response:
43-
43+
```json
4444
{
4545
"zone": "FR",
4646
"carbonIntensity": 103,
@@ -50,6 +50,7 @@ These two services, despite being provided by the same company, use different AP
5050
"isEstimated": true,
5151
"estimationMethod": "TIME_SLICER_AVERAGE"
5252
}
53+
```
5354
5455
The goal is to support both services, to maximize the usage of the Carbon Aware SDK. The question is how to handle these differences.
5556
Treating them as the same data source would require to add some complexity, to distinguish whether an account is free or paid. This distinction would have to be either in the form of an extra parameter, or it would require the Carbon Aware SDK to test every time (at least once per session) which service is meant, using a fallback logic: try the paid service first, and if you get an error try the free one. This adds complexity, requires managing the error code, and in any case forces to make more calls, which has a negative impact on the emissions.

casdk-docs/docs/quickstart.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ Prerequisites:
1919
- Docker
2020
- VSCode (it is recommended to work in a Dev Container)
2121
- Remote Containers extension for VSCode:
22-
<https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>
22+
[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
2323

2424
The CLI can either be run locally with `dotnet` or in a container, e.g. using
2525
VSCode Remote Containers (Dev Container). To run locally:
2626

2727
1. Make sure you have the repository cloned:
28-
<https://github.com/Green-Software-Foundation/carbon-aware-sdk.git>
28+
[https://github.com/Green-Software-Foundation/carbon-aware-sdk.git](https://github.com/Green-Software-Foundation/carbon-aware-sdk.git)
2929
2. `git clone https://github.com/Green-Software-Foundation/carbon-aware-sdk.git`
3030
3. Change directory to: `cd carbon-aware-sdk/src/CarbonAware.CLI/src`
3131
4. If you have a WattTime account registered (or other data source) - you will
@@ -176,10 +176,10 @@ Prerequisites:
176176
- Docker Desktop/CLI
177177
- VSCode (it is recommended to work in a Dev Container)
178178
- Remote Containers extension for VSCode:
179-
<https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>
179+
[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
180180

181181
First we need to set up the GitHub repository
182-
(<https://github.com/Green-Software-Foundation/carbon-aware-sdk.git>):
182+
([https://github.com/Green-Software-Foundation/carbon-aware-sdk.git](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)):
183183

184184
1. `git clone https://github.com/Green-Software-Foundation/carbon-aware-sdk.git`
185185
2. Change directory into the repository: `cd carbon-aware-sdk`
@@ -233,11 +233,11 @@ First we need to set up the GitHub repository
233233
Prerequisites:
234234

235235
- `curl` or other tool that allows making HTTP requests (e.g. `wget`)
236-
- Recommended: `jq` for parsing JSON output: <https://stedolan.github.io/jq/>
236+
- Recommended: `jq` for parsing JSON output: [https://stedolan.github.io/jq/](https://stedolan.github.io/jq/)
237237

238238
With the API running on `localhost:5073`, we can make HTTP requests to its
239239
endpoints, full endpoint description can be found here:
240-
<https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/src/CarbonAware.WebApi/src/README.md>
240+
[https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/src/CarbonAware.WebApi/src/README.md](https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/src/CarbonAware.WebApi/src/README.md)
241241

242242
To get a list of all locations supported, you can use the Locations API endpoint
243243
`/locations` referenced in

casdk-docs/docs/tutorial-basics/carbon-aware-webapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -394,8 +394,8 @@ that time period.
394394

395395
This endpoint lists all the supported locations that the datasources potentially
396396
can have access to. This information is coming from the `location-source/json`
397-
files, that contain dictionaries in the form of <A Location key name,
398-
GeoCoordinates>, for instance:
397+
files, that contain dictionaries in the form of `<A Location key name,
398+
GeoCoordinates>`, for instance:
399399

400400
```json
401401
{

0 commit comments

Comments
 (0)