Skip to content

Commit

Permalink
Release 1.9.0 fix syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
agriffard committed Feb 3, 2024
1 parent 8bf6f94 commit ae6fb7a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions src/docs/releases/1.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Release date: Not yet released

## Breaking Changes

### Drop Newtonsoft.Json` Support
### Drop Newtonsoft.Json support

The utilization of [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json) `has been discontinued in both **YesSql** and **OrchardCore**. Instead, we have transitioned to utilize `System.Text.Json` due to its enhanced performance capabilities. To ensure compatibility with `System.Text.Json` during the serialization or deserialization of objects, the following steps need to be undertaken:
The utilization of [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json) has been discontinued in both **YesSql** and **OrchardCore**. Instead, we have transitioned to utilize `System.Text.Json` due to its enhanced performance capabilities. To ensure compatibility with `System.Text.Json` during the serialization or deserialization of objects, the following steps need to be undertaken:

- If your custom `Document` includes a collection with a getter-only property, it is imperative to incorporate a setter or utilize the `init` modifier to facilitate the assignment of values by `System.Text.Json`. For instance:

Expand All @@ -26,15 +26,15 @@ public class MediaProfilesDocument : Document
}
```

- If you are using a custom deployment steps, change how you register it by using the new `AddDeployment<>` extension. This extension adds a new service that is required for proper serialization. For instance, instead of registering your deployment step like this
- If you are using a custom deployment steps, change how you register it by using the new `AddDeployment<>` extension. This extension adds a new service that is required for proper serialization. For instance, instead of registering your deployment step like this:

```csharp
services.AddTransient<IDeploymentSource, AdminMenuDeploymentSource>();
services.AddSingleton<IDeploymentStepFactory>(new DeploymentStepFactory<AdminMenuDeploymentStep>());
services.AddScoped<IDisplayDriver<DeploymentStep>, AdminMenuDeploymentStepDriver>();
```

change it to the following
change it to the following:

```csharp
services.AddDeployment<AdminMenuDeploymentSource, AdminMenuDeploymentStep, AdminMenuDeploymentStepDriver>();
Expand All @@ -46,21 +46,21 @@ services.AddDeployment<AdminMenuDeploymentSource, AdminMenuDeploymentStep, Admin
services.AddJsonDerivedTypeInfo<UrlCondition, Condition>();
```

In particular any type introduced in custom modules inheriting from `MenuItem`, `AdminNode`, `Condition`, `ConditionOperator`, `Query`, `SitemapType` will have to use this method.
In particular, any type introduced in custom modules inheriting from `MenuItem`, `AdminNode`, `Condition`, `ConditionOperator`, `Query`, `SitemapType` will have to use this method.

### Media Indexing

Previously, `.pdf` files were automatically indexed in the search providers (Elasticsearch, Lucene or Azure AI Search). Now, if you want to continue to index `.PDF` file you'll need to enable `OrchardCore.Media.Indexing.Pdf` feature.
Previously, `.pdf` files were automatically indexed in the search providers (Elasticsearch, Lucene or Azure AI Search). Now, if you want to continue to index `.PDF` file you'll need to enable the `OrchardCore.Media.Indexing.Pdf` feature.

Additionally, if you need to enable indexing for text file with `.txt`, `.md` extensions, you'll needed `OrchardCore.Media.Indexing.Text` feature.
Additionally, if you need to enable indexing for text file with `.txt`, `.md` extensions, you will need the `OrchardCore.Media.Indexing.Text` feature.

If you need to enable indexing for other extensions like (`.docx`, or `.pptx`), you'll need `OrchardCore.Media.Indexing.OpenXML` feature.
If you need to enable indexing for other extensions like (`.docx`, or `.pptx`), you will need the `OrchardCore.Media.Indexing.OpenXML` feature.

### SMS Module

In the past, we utilized the injection of `ISmsProvider` for sending SMS messages. However, in this release, it is now necessary to inject `ISmsService` instead.

Additionally, `Twilio` provider is no longer enabled by default. If you want to use Twilio SMS provider, you must enable `OrchardCore.Sms.Twilio` feature.
Additionally, `Twilio` provider is no longer enabled by default. If you want to use Twilio SMS provider, you must enable the `OrchardCore.Sms.Twilio` feature.

## Change Logs

Expand All @@ -70,7 +70,7 @@ Introducing a new "Azure AI Search" module, designed to empower you in the admin

### Deployment Module

Added new extensions to make registering custom deployment step easier
Added new extensions to make registering custom deployment step easier:

- `services.AddDeployment<TSource, TStep>()`.
- `services.AddDeployment<TSource, TStep, TDisplayDriver>()`.
Expand Down

0 comments on commit ae6fb7a

Please sign in to comment.