merge and bug fixes

Green-Software-Foundation · Feb 12, 2024 · cc15035 · cc15035
1 parent 042123d
commit cc15035
Show file tree

Hide file tree

Showing 58 changed files with 252 additions and 13,154 deletions.
diff --git a/casdk-docs/blog/2022-10-01-release-1.0.mdx b/casdk-docs/blog/2022-10-01-release-1.0.mdx
@@ -1,7 +1,7 @@
 ---
-slug: release-v1.1
-title: Release v1.1
-tags: [v1.1, release]
+slug: release-v1.0
+title: Release v1.0
+tags: [v1.0, release]
 ---
 
 Release 1.1
@@ -54,7 +54,7 @@ Release 1.1
 
 ### Upgrading from 1.0.0 to 1.1.0 
 
-- Configuration changes are required due to historical and forecast configuration now being decoupled.  Refer to - [Configuration](/casdk-docs/docs/configuration.md) for a guide. The following is provided as an example of the new data source configuration format.
+- Configuration changes are required due to historical and forecast configuration now being decoupled.  Refer to - [Configuration](../docs/tutorial-extras/configuration) for a guide. The following is provided as an example of the new data source configuration format.
 ```json
 {
   "DataSources": {

diff --git a/casdk-docs/blog/2023-07-18-release-1.1.mdx b/casdk-docs/blog/2023-07-18-release-1.1.mdx
@@ -54,7 +54,7 @@ Release 1.1
 
 ### Upgrading from 1.0.0 to 1.1.0 
 
-- Configuration changes are required due to historical and forecast configuration now being decoupled.  Refer to - [Configuration](/casdk-docs/docs/configuration.md) for a guide. The following is provided as an example of the new data source configuration format.
+- Configuration changes are required due to historical and forecast configuration now being decoupled.  Refer to - [Configuration](../docs/tutorial-extras/configuration.md) for a guide. The following is provided as an example of the new data source configuration format.
 ```json
 {
   "DataSources": {

diff --git a/casdk-docs/docs/architecture/decisions/0009-sdk-as-a-csharp-client-library.md b/casdk-docs/docs/architecture/decisions/0009-sdk-as-a-csharp-client-library.md
@@ -1,4 +1,4 @@
-# 0009. SDK as a C# Client Library
+# 9. SDK as a C# Client Library
 
 ## Status
 

diff --git a/casdk-docs/docs/architecture/decisions/_category_.json b/casdk-docs/docs/architecture/decisions/_category_.json
diff --git a/docs/images/codespaces-browser-1.png → ...docs/docs/images/codespaces-browser-1.png b/docs/images/codespaces-browser-1.png → ...docs/docs/images/codespaces-browser-1.png
diff --git a/docs/images/codespaces-ports-1.png → ...k-docs/docs/images/codespaces-ports-1.png b/docs/images/codespaces-ports-1.png → ...k-docs/docs/images/codespaces-ports-1.png
diff --git a/docs/images/codespaces-terminal-1.png → ...ocs/docs/images/codespaces-terminal-1.png b/docs/images/codespaces-terminal-1.png → ...ocs/docs/images/codespaces-terminal-1.png
diff --git a/images/screenshot_cli.png → casdk-docs/docs/images/screenshot_cli.png b/images/screenshot_cli.png → casdk-docs/docs/images/screenshot_cli.png
diff --git a/images/screenshot_web_api.png → ...k-docs/docs/images/screenshot_web_api.png b/images/screenshot_web_api.png → ...k-docs/docs/images/screenshot_web_api.png
diff --git a/casdk-docs/docs/overview.md b/casdk-docs/docs/overview.md
diff --git a/docs/architecture/_category_.json → casdk-docs/docs/overview/_category_.json b/docs/architecture/_category_.json → casdk-docs/docs/overview/_category_.json
@@ -1,6 +1,6 @@
 {
-  "label": "Architecture",
-  "position": 3,
+  "label": "Overview",
+  "position": 1,
   "link": {
     "type": "generated-index"
   }

diff --git a/docs/adopters.md → casdk-docs/docs/overview/adopters.md b/docs/adopters.md → casdk-docs/docs/overview/adopters.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+---
+
 # Carbon Aware SDK adopters
 
 We're sharing adopters of the Carbon Aware SDK with public evidence, although we know many others are also using the Carbon Aware SDK to reduce the carbon footprint their software.

diff --git a/docs/enablement.md → casdk-docs/docs/overview/enablement.md b/docs/enablement.md → casdk-docs/docs/overview/enablement.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 2
+---
+
 # Enablement
 
 ## Table of Contents
@@ -41,12 +45,12 @@ environment:
 
 * CLI  
 You can run the application using the [CLI](../src/CarbonAware.CLI) and refer
-  to more documentation [here](./carbon-aware-cli.md).  
+  to more documentation [here](../tutorial-basics/carbon-aware-cli.md).  
 
 * WebAPI  
 You can build a container containing the [WebAPI](../src/CarbonAware.WebApi)
   and connect via REST requests and refer to more documentation
-  [here](./carbon-aware-webapi.md).
+  [here](../tutorial-basics/carbon-aware-webapi.md).
 
 * SDK  
 You can reference the [Carbon Aware C# Library](../src/GSF.CarbonAware) in your
@@ -59,7 +63,7 @@ You can reference the [Carbon Aware C# Library](../src/GSF.CarbonAware) in your
 ### Use cases
 
 CarbonAwareSDK has been embraced by the industry leaders across the globe. Here
-we show some examples of the [use case](./adoptors.md).
+we show some examples of the [use case](./adopters.md).
 
 ## 2. How to use Carbon Aware SDK?
 
@@ -75,8 +79,8 @@ We support various data sources of carbon aware data:
 * JSON file
 
 There are a few constraints to select data sources to some functions of
-CarbonAwareSDK. You can also visit the [Selecting a Data Source](selecting-a-date-source.md)
-guide for further information on data sources options, and [Data Sources](./architecture/data-sources.md)
+CarbonAwareSDK. You can also visit the [Selecting a Data Source](../tutorial-extras/selecting-a-data-source.md)
+guide for further information on data sources options, and [Data Sources](../architecture/data-sources.md)
 for detailed architecture decisions around integrating different data
 providers into the carbon aware SDK.
 
@@ -235,7 +239,7 @@ Expected output:
 ##### Deploying with Container
 
 First we need to set up the GitHub repository
-(<https://github.com/Green-Software-Foundation/carbon-aware-sdk.git>):
+[https://github.com/Green-Software-Foundation/carbon-aware-sdk.git](https://github.com/Green-Software-Foundation/carbon-aware-sdk.git):
 
 1. `git clone https://github.com/Green-Software-Foundation/carbon-aware-sdk.git`
 2. Change directory into the repository: `cd carbon-aware-sdk`
@@ -438,7 +442,7 @@ that installing the SDK from local directory
 Prerequisites:
 
 * `curl` or other tool that allows making HTTP requests (e.g. `wget`)
-* Recommended: `jq` for parsing JSON output: <https://stedolan.github.io/jq/>
+* Recommended: `jq` for parsing JSON output: [https://stedolan.github.io/jq/](https://stedolan.github.io/jq/)
 
 With the API running on `localhost:5073`, we can make HTTP requests to its
 endpoints, full endpoint description can be found [here](https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/src/CarbonAware.WebApi/src/README.md)
@@ -560,7 +564,7 @@ means that if the same configuration value is found in both `appsettings.json`
 and as an environment variable, the value from the environment variable will be
 the value that's applied.
 
-See [configuration.md](/docs/configuration.md) for details about how to
+See [configuration.md](../tutorial-extras/configuration.md) for details about how to
 configure specific components of the application.
 
 #### Environment variables