OSOE-897: Update Menu Widget display name, description and readme

Lombiq.HelpfulExtensions.Tests.UI/Constants/WidgetTypes.cs

@@ -5,6 +5,6 @@ public static class WidgetTypes
     public const string Container = nameof(Container);
     public const string Html = nameof(Html);
     public const string Liquid = nameof(Liquid);
-    public const string Menu = nameof(Menu);
+    public const string Menu = "Menu Navigation Provider";
     public const string Markdown = nameof(Markdown);
 }

Lombiq.HelpfulExtensions/Extensions/Widgets/Migrations.cs

@@ -4,6 +4,7 @@
 using OrchardCore.ContentManagement.Metadata;
 using OrchardCore.ContentManagement.Metadata.Settings;
 using OrchardCore.Data.Migration;
+using OrchardCore.Navigation;
 using System.Threading.Tasks;
 using static Lombiq.HelpfulExtensions.Extensions.Widgets.WidgetTypes;
 
@@ -48,6 +49,11 @@ await _contentDefinitionManager.AlterTypeDefinitionAsync(LiquidWidget, builder =
         await _contentDefinitionManager.AlterTypeDefinitionAsync(MenuWidget, builder => builder
             .Securable()
             .Stereotype(CommonStereotypes.Widget)
+            .DisplayedAs("Menu Navigation Provider Widget")
+            .WithDescription(
+                $"Renders a menu whose contents are populated from {nameof(INavigationProvider)} implementations " +
+                $"that look for the \"menu\" name (as opposed to admin menu navigation providers that use the " +
+                $"\"admin\" name).")
         );
 
         await _contentDefinitionManager.AlterTypeDefinitionAsync(MarkdownWidget, builder => builder
@@ -76,7 +82,7 @@ await _contentDefinitionManager.AlterTypeDefinitionAsync(WidgetTypes.ContentItem
             .WithPart(contentItemWidgetPartName)
         );
 
-        return 5;
+        return 6;
     }
 
     public async Task<int> UpdateFrom1Async()
@@ -128,4 +134,17 @@ await _contentDefinitionManager.AlterTypeDefinitionAsync(WidgetTypes.ContentItem
 
         return 5;
     }
+
+    public async Task<int> UpdateFrom5Async()
+    {
+        await _contentDefinitionManager.AlterTypeDefinitionAsync(MenuWidget, builder => builder
+            .DisplayedAs("Menu Navigation Provider Widget")
+            .WithDescription(
+                $"Renders a menu whose contents are populated from {nameof(INavigationProvider)} implementations " +
+                $"that look for the \"menu\" name (as opposed to admin menu navigation providers that use the " +
+                $"\"admin\" name).")
+        );
+
+        return 6;
+    }
 }

Lombiq.HelpfulExtensions/Extensions/Widgets/Readme.md

@@ -2,9 +2,20 @@
 
 Adds multiple helpful widget content types. These are basic widgets that are added by built-in Orchard Core recipes though in case of using a custom setup recipe these can be added by this feature too.
 
-Includes:
+## ContainerWidget
 
-- ContainerWidget: Works as a container for further widgets. It has a FlowPart attached to it so it can contain additional widgets as well.
-- HtmlWidget: Adds HTML editing and displaying capabilities using a WYSIWYG editor.
-- LiquidWidget: Adds Liquid code editing and rendering capabilities.
-- MenuWidget: Renders a Bootstrap navigation menu as a widget using the provided `MenuItem`s.
+Works as a container for further widgets. It has a FlowPart attached to it so it can contain additional widgets as well.
+
+## HtmlWidget
+
+Adds HTML editing and displaying capabilities using a WYSIWYG editor.
+
+## LiquidWidget
+
+Adds Liquid code editing and rendering capabilities.
+
+## MenuWidget ("Menu Navigation Provider Widget")
+
+Renders a Bootstrap navigation menu as a widget using the provided `MenuItem`s.
+
+> ℹ️ The menu is populated from `INavigationProvider` implementations that create the menu items programmatically. If you use [Lombiq Base Theme for Orchard Core](https://github.com/Lombiq/Orchard-Base-Theme), it has [`MainMenuNavigationProvider`](https://github.com/Lombiq/Orchard-Base-Theme/blob/dev/Lombiq.BaseTheme/Services/MainMenuNavigationProvider.cs). This automatically translates an existing content item with a `MenuItemsListPart` and the `main-menu` alias into compatible navigation, so you can edit menu items from the content editor.