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

Docs/blog update for releases 1.3 to1.5 and fix #551

Merged
merged 10 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion casdk-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
### Installation

```
$ yarn
$ yarn
```

### Local Development
Expand Down
54 changes: 54 additions & 0 deletions casdk-docs/blog/2024-02-13-release-1.3.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
slug: release-v1.3
title: Release v1.3
tags: [v1.3, release]
---

Release 1.3


### Added

- docs site at https://carbon-aware-sdk.greensoftware.foundation/
- [PR #464 Create SECURITY.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/464)
- [PR #461 CarbonHack24 Update to README.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/461)
- [PR #457 Features/codespaces quickstart ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/457)
- [PR #459 Readme updates for clarity ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/459)
- [PR #449 Support location source setting in Helm chart ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/449)
- [PR #431 Update documentation of Usefulness (adopters.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/431)
- [#416 Add disclaimer banner to any public-facing documentation (docusaurus webpage) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/416)
- [#415 Update documentation of secureness (security.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/415)
- [#414 Update documentation of Usefulness (adopters.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/414)
- [#413 Update documentation for Test Coverage ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/413)
- [#412 Update documentation for End User Guide (enablement.md) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/412)
- [#410 Update documentation for How to contribute (contributing.md ) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/410)

### Fixed

- [#344 [Bug]: Fix and update doc deployment workflow ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/344)

### Changed

- [#411 Update documentation for Project overview (ReadMe) ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/411)
- [PR #454 Update quickstart.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/454)
- [PR #453 Update overview.md ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/453)

#### API

-

#### API Deployment

-

#### SDK

-


#### Other

-


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)
4 changes: 2 additions & 2 deletions casdk-docs/blog/2024-05-16-dotnet8/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: .NET 8 upgrade
slug: dotnet-8-upgrade
title: Carbon Aware SDK 1.4, behind the scenes
tags: [dotnet8]
tags: [dotnet8, post]
---

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.
Expand Down
48 changes: 48 additions & 0 deletions casdk-docs/blog/2024-05-24-release-1.4.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
slug: release-v1.4
title: Release v1.4
tags: [v1.4, release]
---

Release 1.4


### Added

- [#401 Feature Contribution: Upgrade .NET version to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/401)
- [#419 Feature Contribution: Migrate sample implementation of Azure Function to isolated worker model ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/419)
- [PR #500 Up Helm chart version to 1.2.0 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/500)

- [#397 Feature Contribution: Data caching in the SDK ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/397)

### Fixed

- [#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)
- [#496 URGENT WebAPI container has not built due to segmentation fault ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/496)
- [#487 Bug: Getting started guide is lost ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/487)

### Changed

- [#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)
- [PR #485 Docs overview, disclaimer & pipeline updates for graduation ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/485)

#### API

-

#### API Deployment

-

#### SDK

-


#### Other

-


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)

78 changes: 78 additions & 0 deletions casdk-docs/blog/2024-07-23-release-1.5.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
slug: release-v1.5
title: Release v1.5
tags: [v1.5, release]
---

Release 1.5

This is the WattTime v3 update. Most notable changes that may require action are for deployment configuration, and these are minor.

### Added

WattTime v3 API support. This is an inplace upgrade for v2.

- [PR #532 Watt Time v3 Support ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/532)
- [PR #340 Add example for 'podman play kube' ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/340)
- [PR #536 Updated azure-regions.json with new regions ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/536)
- [#519 Remove hackathon sentence from our website banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/519)
- [#510 Gap Analysis for WattTime v3 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510)
- [#262 Feature Contribution: Publish the docker file in a docker registry ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262)

### Removed

WattTime v2 API support due to v3 in place replacement.

### Fixed

- [PR #522 Remove Hack mention from the Docs's banner ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/522)
- [#535 Bug: Configuration for locations loads twice ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/535)
- [PR #516 Update published documentation to .NET 8 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/516)
- [PR #515 overview.md: Fixed three broken links Signed-off-by: joecus1 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/515)
- [#506 Check our published documentation to identify any references to .NET7 ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/506)
- [#512 Bug: Broken links in overview.md file ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/512)

### Changed

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).

#### API

No changes

#### API Deployment

Due to the change for WattTime v3, there is change to the configuration for WattTime users.

With some of the changes to the code, some of the configuration will also needs to change.

| Config (v2) | Config (v3) | Description |
|------------------------------------|----------------------------------|------------------------------|
| `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 |
| n/a | `AuthenticationBaseUrl` | **NEW** This is the base URL for the WattTime Authentication API and defaults to `https://api.watttime.org/` if not set. |

Example below if set (note they do not have to be set)
```json
"wattTime_no-proxy": {
"Type": "WattTime",
"Username": "the_username",
"Password": "super_secret_secret",
"BaseURL": "https://api.watttime.org/v3/",
"AutenticationBaseURL": "https://api.watttime.org", // This is new but not mandatory in config
"RegionCacheTTL": 86400, // This is changed but not mandatory in config
"Proxy": {
"UseProxy": false
}
```

#### SDK

No changes


#### Other

No changes


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)
42 changes: 0 additions & 42 deletions casdk-docs/blog_preview/2024-02-13-release-1.3.mdx

This file was deleted.

10 changes: 5 additions & 5 deletions casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ The `Login` is now at a different base URL, and to avoid any future issues a dif

| API Endpoint | Description | Path (v2) | Path (v3) | Notes |
|--------------|-------------|-----------|-----------|---|
| 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
| 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
| 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
| 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 |
| 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.
| 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>|
| 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>
| 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>
| 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> |
| 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. |

### Query Strings

Expand Down
2 changes: 1 addition & 1 deletion casdk-docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

#__blog-post-container img, .theme-doc-markdown img{
#__blog-post-container img, .theme-doc-markdown img, article img{
height: auto;
}
Loading