Skip to content

Update published documentation to .NET 8 #516

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

Merged
merged 4 commits into from
May 14, 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
10 changes: 5 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ We perform regular reviews inline with the information provided below. All rele

### Use basic good cryptographic practices
- https://www.bestpractices.dev/en/criteria/0#0.crypto_published - ✅ uses HTTPS for WebAPI, N/A for CLI
- https://www.bestpractices.dev/en/criteria/0#0.crypto_floss - ✅ uses dotnet 6.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_keylength - ✅ uses dotnet 6.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_working - ✅ uses dotnet 6.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_password_storage - ✅ ⚠️ uses dotnet 6.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_random - ✅ uses dotnet 6.0 implementatons for HTTPS
- https://www.bestpractices.dev/en/criteria/0#0.crypto_floss - ✅ uses dotnet 8.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_keylength - ✅ uses dotnet 8.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_working - ✅ uses dotnet 8.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_password_storage - ✅ ⚠️ uses dotnet 8.0 implementations
- https://www.bestpractices.dev/en/criteria/0#0.crypto_random - ✅ uses dotnet 8.0 implementatons for HTTPS

### Secured delivery against man-in-the-middle (MITM) attacks
- Delivery mechanisms that counters MITM - ✅ uses HTTPS
Expand Down
12 changes: 6 additions & 6 deletions casdk-docs/docs/overview/enablement.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ different endpoints to provide the most flexibility to integrate to your
environment:

* CLI
You can run the application using the [CLI](../src/CarbonAware.CLI) and refer
You can run the application using the [CLI](/src/CarbonAware.CLI) and refer
to more documentation [here](../tutorial-basics/carbon-aware-cli.md).

* WebAPI
You can build a container containing the [WebAPI](../src/CarbonAware.WebApi)
You can build a container containing the [WebAPI](/src/CarbonAware.WebApi)
and connect via REST requests and refer to more documentation
[here](../tutorial-basics/carbon-aware-webapi.md).

* SDK
You can reference the [Carbon Aware C# Library](../src/GSF.CarbonAware) in your
You can reference the [Carbon Aware C# Library](/src/GSF.CarbonAware) in your
projects and make use of its functionalities and features.

| ![Image 2](./images/readme/screenshot_cli.png) | ![Image 1](./images/readme/screenshot_web_api.png) |
Expand Down Expand Up @@ -87,7 +87,7 @@ providers into the carbon aware SDK.
#### System requirement

* Command Line Interface (CLI)
* .NET Core 6.0
* .NET 8.0
* Alternatively:
* Docker
* VSCode and its [Remote Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
Expand Down Expand Up @@ -588,7 +588,7 @@ using environment variables, you'd do this:
#### Local project settings

For local-only settings you can use environment variables,
[the Secret Manager tool](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-6.0&tabs=windows#secret-manager)
[the Secret Manager tool](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?tabs=windows#secret-manager)
, or an untracked Development appsettings file to override the default project
settings.

Expand All @@ -598,7 +598,7 @@ remove the first line of (invalid) comments. Then update any settings according
to your preferences.

> Wherever possible, the projects leverage the
> [default .NET configuration](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-6.0#default-application-configuration-sources)
> [default .NET configuration](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?#default-application-configuration-sources)
> expectations. Thus, they can be configured using any file matching the format:
> `appsettings.<ENV>.json`. Where `<ENV>` is the value of the
> `ASPNETCORE_ENVIRONMENT` environment variable. By convention projects tend to
Expand Down