Skip to content

Commit 0b092c9

Browse files
authored
Docs/blog update for releases 1.3 to1.5 and fix (#551)
* Catching up on release blog posts for 1.3, 1.4 and 1.5 Signed-off-by: Dan Benitah <[email protected]> * fixed docusaurus (strict) compilation error * release dates updated Signed-off-by: Dan Benitah <[email protected]> * added tag Signed-off-by: Dan Benitah <[email protected]> * tag update to post and image layout fix Signed-off-by: Dan Benitah <[email protected]> * updated slug Signed-off-by: Dan Benitah <[email protected]> * formatting fix Signed-off-by: Dan Benitah <[email protected]> * DCO Remediation Commit for Dan Benitah <[email protected]> I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 53e120c Signed-off-by: Dan Benitah <[email protected]> * formatting * DCO Remediation Commit for Dan Benitah <[email protected]> I, Dan Benitah <[email protected]>, hereby add my Signed-off-by to this commit: 0f6cada Signed-off-by: Dan Benitah <[email protected]> --------- Signed-off-by: Dan Benitah <[email protected]>
1 parent 6bbd05e commit 0b092c9

File tree

8 files changed

+189
-51
lines changed

8 files changed

+189
-51
lines changed

casdk-docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
55
### Installation
66

77
```
8-
$ yarn
8+
$ yarn
99
```
1010

1111
### Local Development
+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
slug: release-v1.3
3+
title: Release v1.3
4+
tags: [v1.3, release]
5+
---
6+
7+
Release 1.3
8+
9+
10+
### Added
11+
12+
- docs site at https://carbon-aware-sdk.greensoftware.foundation/
13+
- [PR #464 Create SECURITY.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/464)
14+
- [PR #461 CarbonHack24 Update to README.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/461)
15+
- [PR #457 Features/codespaces quickstart ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/457)
16+
- [PR #459 Readme updates for clarity ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/459)
17+
- [PR #449 Support location source setting in Helm chart ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/449)
18+
- [PR #431 Update documentation of Usefulness (adopters.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/431)
19+
- [#416 Add disclaimer banner to any public-facing documentation (docusaurus webpage) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/416)
20+
- [#415 Update documentation of secureness (security.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/415)
21+
- [#414 Update documentation of Usefulness (adopters.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/414)
22+
- [#413 Update documentation for Test Coverage ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/413)
23+
- [#412 Update documentation for End User Guide (enablement.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/412)
24+
- [#410 Update documentation for How to contribute (contributing.md ) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/410)
25+
26+
### Fixed
27+
28+
- [#344 [Bug]: Fix and update doc deployment workflow ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/344)
29+
30+
### Changed
31+
32+
- [#411 Update documentation for Project overview (ReadMe) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/411)
33+
- [PR #454 Update quickstart.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/454)
34+
- [PR #453 Update overview.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/453)
35+
36+
#### API
37+
38+
-
39+
40+
#### API Deployment
41+
42+
-
43+
44+
#### SDK
45+
46+
-
47+
48+
49+
#### Other
50+
51+
-
52+
53+
54+
For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/474](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/474)

casdk-docs/blog/2024-05-16-dotnet8/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
slug: .NET 8 upgrade
2+
slug: dotnet-8-upgrade
33
title: Carbon Aware SDK 1.4, behind the scenes
4-
tags: [dotnet8]
4+
tags: [dotnet8, post]
55
---
66

77
As most software nowadays, the Carbon Aware SDK relies on a stack of utilities, and while adding a new feature is usually the most appealing for a project, it’s also critical to maintain the stack, especially in a community effort.
+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
slug: release-v1.4
3+
title: Release v1.4
4+
tags: [v1.4, release]
5+
---
6+
7+
Release 1.4
8+
9+
10+
### Added
11+
12+
- [#401 Feature Contribution: Upgrade .NET version to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/401)
13+
- [#419 Feature Contribution: Migrate sample implementation of Azure Function to isolated worker model ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/419)
14+
- [PR #500 Up Helm chart version to 1.2.0 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/500)
15+
16+
- [#397 Feature Contribution: Data caching in the SDK ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/397)
17+
18+
### Fixed
19+
20+
- [#505 Bug: Project Page wiki from GSF website still says it's in incubation ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/505)
21+
- [#496 URGENT WebAPI container has not built due to segmentation fault ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/496)
22+
- [#487 Bug: Getting started guide is lost ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/487)
23+
24+
### Changed
25+
26+
- [#477 Bug: Ensure the readme file shows as the project overview content on the documentation site ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/477)
27+
- [PR #485 Docs overview, disclaimer & pipeline updates for graduation ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/485)
28+
29+
#### API
30+
31+
-
32+
33+
#### API Deployment
34+
35+
-
36+
37+
#### SDK
38+
39+
-
40+
41+
42+
#### Other
43+
44+
-
45+
46+
47+
For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503)
48+
+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
slug: release-v1.5
3+
title: Release v1.5
4+
tags: [v1.5, release]
5+
---
6+
7+
Release 1.5
8+
9+
This is the WattTime v3 update. Most notable changes that may require action are for deployment configuration, and these are minor.
10+
11+
### Added
12+
13+
WattTime v3 API support. This is an inplace upgrade for v2.
14+
15+
- [PR #532 Watt Time v3 Support ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/532)
16+
- [PR #340 Add example for 'podman play kube' ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/340)
17+
- [PR #536 Updated azure-regions.json with new regions ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/536)
18+
- [#519 Remove hackathon sentence from our website banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/519)
19+
- [#510 Gap Analysis for WattTime v3 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510)
20+
- [#262 Feature Contribution: Publish the docker file in a docker registry ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262)
21+
22+
### Removed
23+
24+
WattTime v2 API support due to v3 in place replacement.
25+
26+
### Fixed
27+
28+
- [PR #522 Remove Hack mention from the Docs's banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/522)
29+
- [#535 Bug: Configuration for locations loads twice ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/535)
30+
- [PR #516 Update published documentation to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/516)
31+
- [PR #515 overview.md: Fixed three broken links Signed-off-by: joecus1 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/515)
32+
- [#506 Check our published documentation to identify any references to .NET7 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/506)
33+
- [#512 Bug: Broken links in overview.md file ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/512)
34+
35+
### Changed
36+
37+
Updates for WattTime v3 API endpoint from v2, details in the [ADR for WattTime v3 changes](./casdk-docs/docs/architecture//decisions/0016-watt-time-v3.md).
38+
39+
#### API
40+
41+
No changes
42+
43+
#### API Deployment
44+
45+
Due to the change for WattTime v3, there is change to the configuration for WattTime users.
46+
47+
With some of the changes to the code, some of the configuration will also needs to change.
48+
49+
| Config (v2) | Config (v3) | Description |
50+
|------------------------------------|----------------------------------|------------------------------|
51+
| `BalancingAuthorityCacheTTL` | `RegionCacheTTL` | This is the cache for regions data in seconds, and has a default value of 1 day. This only needs updating if you set it |
52+
| n/a | `AuthenticationBaseUrl` | **NEW** This is the base URL for the WattTime Authentication API and defaults to `https://api.watttime.org/` if not set. |
53+
54+
Example below if set (note they do not have to be set)
55+
```json
56+
"wattTime_no-proxy": {
57+
"Type": "WattTime",
58+
"Username": "the_username",
59+
"Password": "super_secret_secret",
60+
"BaseURL": "https://api.watttime.org/v3/",
61+
"AutenticationBaseURL": "https://api.watttime.org", // This is new but not mandatory in config
62+
"RegionCacheTTL": 86400, // This is changed but not mandatory in config
63+
"Proxy": {
64+
"UseProxy": false
65+
}
66+
```
67+
68+
#### SDK
69+
70+
No changes
71+
72+
73+
#### Other
74+
75+
No changes
76+
77+
78+
For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503)

casdk-docs/blog_preview/2024-02-13-release-1.3.mdx

-42
This file was deleted.

casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ The `Login` is now at a different base URL, and to avoid any future issues a dif
3737

3838
| API Endpoint | Description | Path (v2) | Path (v3) | Notes |
3939
|--------------|-------------|-----------|-----------|---|
40-
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `ba` is now `region` <li> `signal_type` added <br> _Response_ <li> `signal_type` added
41-
| Forecast | Get forecast| /forecast | /forecast | <br> No longer be used for historical data <br> _Request_ <li> `ba` is now `region` <li> `extended_forecast` removed <li> `horizon_hours` added <li> `signal_type` added <li> Historical forecasts are now at `/forecast/historical` <br> _Response_ <li> `signal_type` added
42-
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br> _Request_ <li> `ba` is now `region` <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `signal_type` added <br> _Response_ <li> `signal_type` added
43-
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br><br> _Request_ <li> `name` is now `region_full_name` <li> `abbrev` is now `region` <li> `signal_type` added <br> _Response_ <li> `id` removed <li> `signal_type` added |
44-
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br><br> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login.
40+
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory </li> <li> `endtime` is now `end` and mandatory </li><li> `ba` is now `region` </li><li> `signal_type` added _Response_ </li><li> `signal_type` added</li>|
41+
| Forecast | Get forecast| /forecast | /forecast | No longer be used for historical data _Request_ <li> `ba` is now `region` </li><li> `extended_forecast` removed </li><li> `horizon_hours` added </li><li> `signal_type` added </li><li> Historical forecasts are now at `/forecast/historical` <br /> _Response_ </li><li> `signal_type` added </li>
42+
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br /> _Request_ <li> `ba` is now `region` </li><li> `starttime` is now `start` and mandatory </li><li> `endtime` is now `end` and mandatory </li><li> `signal_type` added <br /> _Response_ </li><li> `signal_type` added </li>
43+
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br /><br /> _Request_ <li> `name` is now `region_full_name` </li><li> `abbrev` is now `region` </li><li> `signal_type` added <br /> _Response_ </li><li> `id` removed </li><li> `signal_type` added </li> |
44+
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br /><br /> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login. |
4545

4646
### Query Strings
4747

casdk-docs/src/css/custom.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@
3030
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
3131
}
3232

33-
#__blog-post-container img, .theme-doc-markdown img{
33+
#__blog-post-container img, .theme-doc-markdown img, article img{
3434
height: auto;
3535
}

0 commit comments

Comments
 (0)