Skip to content

Commit a5a416f

Browse files
authored
(#424) Updated docs for .NET 10 (#441)
1 parent d6fb27a commit a5a416f

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

docs/in-depth/client/advanced/maui-aot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ When using [Native AOT with .NET MAUI](https://learn.microsoft.com/dotnet/maui/d
44

55
1. [Implement compiled models for Entity Framework Core](https://learn.microsoft.com/ef/core/performance/advanced-performance-topics?tabs=with-di%2Cexpression-api-with-constant#compiled-models).
66
2. [Implement source generation in System.Text.Json](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/source-generation).
7-
3. [Enable the Interpreter for iOS and Mac Catalyst](https://learn.microsoft.com/dotnet/maui/macios/interpreter?view=net-maui-8.0#enable-the-interpreter).
7+
3. [Enable the Interpreter for iOS and Mac Catalyst](https://learn.microsoft.com/dotnet/maui/macios/interpreter?view=net-maui-10.0#enable-the-interpreter).
88

99
The following are basic instructions on how to fulfill these requirements. However, you should consult the official documentation (linked above) for each requirement.
1010

@@ -15,7 +15,7 @@ The following are basic instructions on how to fulfill these requirements. Howe
1515

1616
To enable compiled models in your MAUI project:
1717

18-
1. Move your `DbContext` and models to a separate library that targets `net8.0`.
18+
1. Move your `DbContext` and models to a separate library that targets `net10.0`.
1919
2. Create a dummy project with a project reference to the library. This will act as a startup project for the EF Core Tools we will run later. This can be as simple as a console application.
2020
3. Implement an `IDesignTimeDbContextFactory` for your context. This can be placed in your dummy project. For example:
2121

@@ -108,7 +108,7 @@ Add the following property to the iOS release configuration in your MAUI app pro
108108

109109
The property group should look something like the following:
110110

111-
<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|net8.0-ios|AnyCPU'">
111+
<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|net10.0-ios|AnyCPU'">
112112
<OptimizePNGs>true</OptimizePNGs>
113113
<MtouchInterpreter>all</MtouchInterpreter>
114114
</PropertyGroup>

docs/in-depth/client/online.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The `HttpClientOptions` allows you to specify the following values:
2929
* `Timeout` - a `TimeSpan` (default: 60 seconds); specifies the `HttpClient.Timeout` value for created clients.
3030
* `UserAgent` - the User-Agent header value for each request. By default, a Datasync service specific value is used.
3131

32-
The HTTP pipeline is an important mechanism by which you can adjust the requests as they flow through the Datasync Community Toolkit. For instance, you might want to use a custom delegating handler for authentication, another for logging, and another for adding an API key to the request. If you are adding a custom [HttpClientHandler](https://learn.microsoft.com/dotnet/api/system.net.http.httpclienthandler?view=net-8.0), then it should be the last element in the `HttpPipeline`. You can specify a pipeline like this:
32+
The HTTP pipeline is an important mechanism by which you can adjust the requests as they flow through the Datasync Community Toolkit. For instance, you might want to use a custom delegating handler for authentication, another for logging, and another for adding an API key to the request. If you are adding a custom [HttpClientHandler](https://learn.microsoft.com/dotnet/api/system.net.http.httpclienthandler?view=net-10.0), then it should be the last element in the `HttpPipeline`. You can specify a pipeline like this:
3333

3434
```csharp
3535
using CommunityToolkit.Datasync.Client.Http;

docs/in-depth/server/db/mysql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
MySQL is supported via the Entity Framework Core repository. Add the [`Pomelo.EntityFrameworkCore.Mysql`](https://www.nuget.org/packages/Pomelo.EntityFrameworkCore.MySql) driver to your project.
44

55
!!! note
6-
You can probably use the `MySql.EntityFrameworkCore` library as well. However, we only test with the Pomelo driver.
6+
As of the v10.0.0 of the Datasync Library, we no longer test MySQL. It **should** work, but we can not make any guarantees. Open an issue if you find problems.
77

88
## Set up
99

docs/in-depth/server/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Because the datasync service is designed to provide disconnected access over int
99

1010
## Supported Platforms
1111

12-
The ASP.NET Core packages support ASP.NET 8.0 or later.
12+
The ASP.NET Core packages support ASP.NET 10.0 or later.
1313

1414
The datasync service support a number of backend database servers, and allows for the custom implementation of repositories. Each entity that is synchronized must meet the following criteria:
1515

@@ -37,8 +37,8 @@ A datasync server based on the Datasync Community Toolkit supports:
3737

3838
To create a new datasync service:
3939

40-
1. Create an ASP.NET 8.0 (or later) WebAPI project.
41-
2. Add Entity Framework Core.
40+
1. Create an ASP.NET 10.0 (or later) WebAPI project.
41+
2. Add Entity Framework Core 10.0 (or later).
4242
3. Add Datasync Community Toolkit.
4343

4444
For information on creating an ASP.NET Core service with Entity Framework Core, see [the official tutorial](https://learn.microsoft.com/aspnet/core/tutorials/first-web-api).
@@ -202,7 +202,7 @@ If you want to allow both unauthenticated and authenticated access to a table, d
202202

203203
## Configure logging
204204

205-
Logging is handled through [the normal logging mechanism](https://learn.microsoft.com/aspnet/core/fundamentals/logging/?view=aspnetcore-8.0) for ASP.NET Core. Assign the `ILogger` object to the `Logger` property:
205+
Logging is handled through [the normal logging mechanism](https://learn.microsoft.com/aspnet/core/fundamentals/logging/?view=aspnetcore-10.0) for ASP.NET Core. Assign the `ILogger` object to the `Logger` property:
206206

207207
[Route("tables/[controller]")]
208208
public class ModelController : TableController<Model>
@@ -255,7 +255,7 @@ The `TableController<T>` base class contains an event handler that is called at
255255

256256
## OpenAPI Support
257257

258-
You can publish the API defined by data sync controllers using [NSwag](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-8.0&tabs=visual-studio), [Swashbuckle](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-8.0&tabs=visual-studio), or the [OpenApi support in .NET 9](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview?view=aspnetcore-9.0). In all cases, start by setting up the service as you normally would for the chosen library.
258+
You can publish the API defined by data sync controllers using [NSwag](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-10.0&tabs=visual-studio), [Swashbuckle](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-10.0&tabs=visual-studio), or the [OpenApi support in .NET 10](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview?view=aspnetcore-10.0). In all cases, start by setting up the service as you normally would for the chosen library.
259259

260260
Review the instructions for each library:
261261

docs/in-depth/server/openapi/net9.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# .NET 9.x OpenApi support
1+
# .NET 10.x OpenApi support
22

3-
Follow [the basic instructions for OpenApi integration](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/aspnetcore-openapi?view=aspnetcore-9.0&tabs=visual-studio), then modify as follows:
3+
Follow [the basic instructions for OpenApi integration](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/aspnetcore-openapi?view=aspnetcore-10.0&tabs=visual-studio), then modify as follows:
44

55
1. Add packages to your project to support NSwag. The following packages are required:
66

@@ -28,4 +28,4 @@ Browsing to the `/openapi/v1.json` endpoint of the web service allows you to dow
2828

2929
## Known issues
3030

31-
The .NET 9.x OpenApi support currently does not support dynamic schema generation. This means that the schema generated within the OpenApi document will be incomplete.
31+
The .NET 10.x OpenApi support currently does not support dynamic schema generation. This means that the schema generated within the OpenApi document will be incomplete.

docs/in-depth/server/openapi/swashbuckle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Swashbuckle support
22

3-
Follow the [basic instructions for Swashbuckle integration](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-8.0&tabs=visual-studio), then modify as follows:
3+
Follow the [basic instructions for Swashbuckle integration](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-10.0&tabs=visual-studio), then modify as follows:
44

55
1. Add packages to your project to support Swashbuckle. The following packages are required:
66

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ The [Datasync Community Toolkit][nuget] is a collection of libraries that implem
44

55
Currently, the library supports:
66

7-
* ASP.NET Core 8.x or later.
8-
* .NET clients using .NET 8.x or later.
7+
* ASP.NET Core 10.x or later.
8+
* .NET clients using .NET 10.x or later.
99

1010
> Ensure you match the version of the Datasync Community Toolkit to the version of .NET you are using.
1111

0 commit comments

Comments
 (0)