Improve documentations for the indexing module (#18016)

Author: MikeAlhayek

src/OrchardCore.Modules/OrchardCore.Indexing/Deployments/IndexProfileDeploymentStepDisplayDriver.cs

@@ -39,7 +39,7 @@ public override IDisplayResult Edit(IndexProfileDeploymentStep step, BuildEditor
             model.IncludeAll = step.IncludeAll;
             model.Indexes = (await _store.GetAllAsync()).Select(x => new SelectListItem(x.Name, x.Id)
             {
-                Selected = step.IndexeIds?.Contains(x.IndexName) ?? false,
+                Selected = step.IndexIds?.Contains(x.IndexName) ?? false,
             }).OrderBy(x => x.Text)
             .ToArray();
         }).Location("Content");
@@ -56,7 +56,7 @@ await context.Updater.TryUpdateModelAsync(model, Prefix,
         if (model.IncludeAll)
         {
             step.IncludeAll = true;
-            step.IndexeIds = [];
+            step.IndexIds = [];
         }
         else
         {
@@ -66,7 +66,7 @@ await context.Updater.TryUpdateModelAsync(model, Prefix,
             }
 
             step.IncludeAll = false;
-            step.IndexeIds = model.Indexes.Where(x => x.Selected).Select(x => x.Value).ToArray();
+            step.IndexIds = model.Indexes.Where(x => x.Selected).Select(x => x.Value).ToArray();
         }
 
         return Edit(step, context);

src/OrchardCore.Modules/OrchardCore.Indexing/Startup.cs

@@ -54,7 +54,7 @@ public sealed class RecipesStartup : StartupBase
 {
     public override void ConfigureServices(IServiceCollection services)
     {
-        services.AddRecipeExecutionStep<IndexingProfileStep>();
+        services.AddRecipeExecutionStep<CreateOrUpdateIndexProfileStep>();
         services.AddRecipeExecutionStep<ResetIndexProfileStep>();
         services.AddRecipeExecutionStep<RebuildIndexProfileStep>();
     }

src/OrchardCore.Modules/OrchardCore.Indexing/Views/Items/IndexProfileDeploymentStep.Summary.cshtml

@@ -11,9 +11,9 @@
 {
     <span class="badge text-bg-success">@T["All Indexes"]</span>
 }
-else if (Model.Value.IndexeIds?.Length > 0)
+else if (Model.Value.IndexIds?.Length > 0)
 {
-    <span class="badge text-bg-warning">@T.Plural(Model.Value.IndexeIds.Length, "1 selected index.", "{0} selected indexes.", Model.Value.IndexeIds.Length)</span>
+    <span class="badge text-bg-warning">@T.Plural(Model.Value.IndexIds.Length, "1 selected index.", "{0} selected indexes.", Model.Value.IndexIds.Length)</span>
 }
 else
 {

src/OrchardCore/OrchardCore.Indexing.Core/Deployments/IndexProfileDeploymentSource.cs

@@ -30,7 +30,7 @@ protected override async Task ProcessAsync(IndexProfileDeploymentStep step, Depl
 
         var sourceIds = step.IncludeAll
             ? []
-            : step.IndexeIds ?? [];
+            : step.IndexIds ?? [];
 
         foreach (var index in indexes)
         {

src/OrchardCore/OrchardCore.Indexing.Core/Deployments/IndexProfileDeploymentStep.cs

@@ -7,10 +7,10 @@ public sealed class IndexProfileDeploymentStep : DeploymentStep
 {
     public IndexProfileDeploymentStep()
     {
-        Name = IndexingProfileStep.StepKey;
+        Name = CreateOrUpdateIndexProfileStep.StepKey;
     }
 
     public bool IncludeAll { get; set; }
 
-    public string[] IndexeIds { get; set; }
+    public string[] IndexIds { get; set; }
 }

src/OrchardCore/OrchardCore.Indexing.Core/Recipes/IndexingProfileStep.cs renamed to src/OrchardCore/OrchardCore.Indexing.Core/Recipes/CreateOrUpdateIndexProfileStep.cs

@@ -7,19 +7,19 @@
 
 namespace OrchardCore.Indexing.Core.Recipes;
 
-public sealed class IndexingProfileStep : NamedRecipeStepHandler
+public sealed class CreateOrUpdateIndexProfileStep : NamedRecipeStepHandler
 {
-    public const string StepKey = "IndexingProfile";
+    public const string StepKey = "CreateOrUpdateIndexProfile";
 
     private readonly IIndexProfileManager _indexProfileManager;
     private readonly IndexingOptions _indexingOptions;
 
     internal readonly IStringLocalizer S;
 
-    public IndexingProfileStep(
+    public CreateOrUpdateIndexProfileStep(
         IIndexProfileManager indexProfileManager,
         IOptions<IndexingOptions> indexingOptions,
-        IStringLocalizer<IndexingProfileStep> stringLocalizer)
+        IStringLocalizer<CreateOrUpdateIndexProfileStep> stringLocalizer)
         : base(StepKey)
     {
         _indexProfileManager = indexProfileManager;
@@ -37,8 +37,9 @@ protected override async Task HandleAsync(RecipeExecutionContext context)
             IndexProfile indexProfile = null;
 
             var id = token[nameof(indexProfile.Id)]?.GetValue<string>();
+            var hasId = !string.IsNullOrEmpty(id);
 
-            if (!string.IsNullOrEmpty(id))
+            if (hasId)
             {
                 indexProfile = await _indexProfileManager.FindByIdAsync(id);
             }
@@ -85,6 +86,11 @@ protected override async Task HandleAsync(RecipeExecutionContext context)
                 }
 
                 indexProfile = await _indexProfileManager.NewAsync(providerName, type, token);
+
+                if (hasId)
+                {
+                    indexProfile.Id = id;
+                }
             }
 
             var validationResult = await _indexProfileManager.ValidateAsync(indexProfile);

src/OrchardCore/OrchardCore.Indexing.Core/Recipes/RebuildIndexProfileStep.cs

@@ -25,7 +25,7 @@ protected override async Task HandleAsync(RecipeExecutionContext context)
             return;
         }
 
-        if (!model.IncludeAll && (model.IndexeIds == null || model.IndexeIds.Length == 0))
+        if (!model.IncludeAll && (model.IndexIds == null || model.IndexIds.Length == 0))
         {
             return;
         }
@@ -36,7 +36,7 @@ await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync("rebuild-index-profile", a
 
             var indexes = model.IncludeAll
                 ? await indexProfileManager.GetAllAsync()
-                : (await indexProfileManager.GetAllAsync()).Where(x => model.IndexeIds.Contains(x.Id, StringComparer.OrdinalIgnoreCase));
+                : (await indexProfileManager.GetAllAsync()).Where(x => model.IndexIds.Contains(x.Id, StringComparer.OrdinalIgnoreCase) || model.IndexIds.Contains(x.Name, StringComparer.OrdinalIgnoreCase));
 
             Dictionary<string, IIndexManager> indexManagers = new();
 

src/OrchardCore/OrchardCore.Indexing.Core/Recipes/ResetIndexProfileStep.cs

@@ -25,7 +25,7 @@ protected override async Task HandleAsync(RecipeExecutionContext context)
             return;
         }
 
-        if (!model.IncludeAll && (model.IndexeIds == null || model.IndexeIds.Length == 0))
+        if (!model.IncludeAll && (model.IndexIds == null || model.IndexIds.Length == 0))
         {
             return;
         }
@@ -36,7 +36,7 @@ await HttpBackgroundJob.ExecuteAfterEndOfRequestAsync("reset-index-profile", asy
 
             var indexes = model.IncludeAll
             ? await indexProfileManager.GetAllAsync()
-            : (await indexProfileManager.GetAllAsync()).Where(x => model.IndexeIds.Contains(x.Id, StringComparer.OrdinalIgnoreCase));
+            : (await indexProfileManager.GetAllAsync()).Where(x => model.IndexIds.Contains(x.Id, StringComparer.OrdinalIgnoreCase) || model.IndexIds.Contains(x.Name, StringComparer.OrdinalIgnoreCase));
 
             foreach (var index in indexes)
             {

src/docs/reference/modules/AzureAISearch/README.md

@@ -83,9 +83,44 @@ The `Create Index Step` create an Azure AI Search index if one does not already
 }
 ```
 
-note !!!
-     It's recommended to use the `Indexing` recipe step instead as the `azureai-index-create` step is obsolete. 
+!!! note
+    It's recommended to use the `CreateOrUpdateIndexProfile` recipe step instead as the `azureai-index-create` step is obsolete. 
 
+Here is an example of how to create `AzureAISearch` index profile using the `IndexProfile` for Content items.
+
+```json
+{
+  "steps":[
+    {
+      "name":"CreateOrUpdateIndexProfile",
+      "indexes": [
+	    {
+		    "Name": "BlogPostsAI",
+            "IndexName": "blogposts",
+		    "ProviderName": "AzureAISearch",
+		    "Type": "Content",
+		    "Properties": {
+			    "ContentIndexMetadata": {
+				    "IndexLatest": false,
+				    "IndexedContentTypes": ["BlogPosts"],
+				    "Culture": "any"
+			    },
+                "AzureAISearchIndexMetadata": {
+                    "AnalyzerName": "standard"
+                },
+                "AzureAISearchDefaultQueryMetadata": {
+                    "QueryAnalyzerName": "standard.lucene",
+                    "DefaultSearchFields": [
+                        "Content__ContentItem__FullText"
+                    ]
+                }
+		    }
+	    }
+      ]
+    }
+  ]
+}
+```
 
 ### Reset Azure AI Search Index Step
 
@@ -118,8 +153,8 @@ To reset all indices:
 }
 ```
 
-note !!!
-     It's recommended to use the `ResetIndexing` recipe step instead as the `azureai-index-reset` step is obsolete. 
+!!! note
+    It's recommended to use the `ResetIndexProfile` recipe step instead as the `azureai-index-reset` step is obsolete. 
 
 ### Rebuild Azure AI Search Index Step
 
@@ -152,8 +187,8 @@ To rebuild all indices:
 }
 ```
 
-note !!!
-     It's recommended to use the `RebuildIndexing` recipe step instead as the `azureai-index-rebuild` step is obsolete. 
+!!! note
+    It's recommended to use the `RebuildIndexProfile` recipe step instead as the `azureai-index-rebuild` step is obsolete. 
 
 ## Search Module (`OrchardCore.Search`)
 

src/docs/reference/modules/Elasticsearch/README.md

@@ -78,8 +78,48 @@ Here is a sample step:
   ]
 }
 ```
-note !!!
-     It's recommended to use the `IndexProfile` recipe step instead as the `ElasticIndexSettings` step is obsolete. 
+
+!!! note
+     It's recommended to use the `CreateOrUpdateIndexProfile` recipe step instead as the `ElasticIndexSettings` step is obsolete. 
+
+Here is an example of how to create `Elasticsearch` index profile using the `IndexProfile` for Content items.
+
+```json
+{
+  "steps":[
+    {
+      "name":"CreateOrUpdateIndexProfile",
+      "indexes": [
+	    {
+		    "Name": "BlogPostsES",
+            "IndexName": "blogposts",
+		    "ProviderName": "Elasticsearch",
+		    "Type": "Content",
+		    "Properties": {
+			    "ContentIndexMetadata": {
+				    "IndexLatest": false,
+				    "IndexedContentTypes": ["BlogPosts"],
+				    "Culture": "any"
+			    },
+                "ElasticsearchIndexMetadata": {
+                    "AnalyzerName": "standard",
+                    "StoreSourceData": true,
+                },
+                "ElasticsearchDefaultQueryMetadata": {
+                    "QueryAnalyzerName": "standard",
+                    "SearchType": "", // The search type can be "query_string", "custom", or empty for default search type.
+                    "DefaultQuery": "", // When using "custom" search type, this is the query to use.
+                    "DefaultSearchFields": [
+                        "Content.ContentItem.FullText"
+                    ]
+                }
+		    }
+	    }
+      ]
+    }
+  ]
+}
+```
 
 ### Reset Elasticsearch Index Step
 
@@ -114,8 +154,8 @@ To reset all indices:
 }
 ```
 
-note !!!
-     It's recommended to use the `ResetIndexProfile` recipe step instead as the `elastic-index-reset` step is obsolete. 
+!!! note
+    It's recommended to use the `ResetIndexProfile` recipe step instead as the `elastic-index-reset` step is obsolete. 
 
 ### Rebuild Elasticsearch Index Step
 
@@ -149,8 +189,8 @@ To rebuild all indices:
 }
 ```
 
-note !!!
-     It's recommended to use the `RebuildIndexProfile` recipe step instead as the `elastic-index-rebuild` step is obsolete. 
+!!! note
+    It's recommended to use the `RebuildIndexProfile` recipe step instead as the `elastic-index-rebuild` step is obsolete. 
 
 ### Queries recipe step