Merge remote-tracking branch 'origin/main' into feature/open-api-docs-2

Author: Mpdreamz

src/Elastic.ApiExplorer/OpenApiGenerator.cs

@@ -12,7 +12,6 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
-using Microsoft.OpenApi.Models.Interfaces;
 
 namespace Elastic.ApiExplorer;
 

src/Elastic.Documentation.Configuration/Assembler/PublishEnvironment.cs

@@ -25,4 +25,7 @@ public record PublishEnvironment
 
 	[YamlMember(Alias = "google_tag_manager")]
 	public GoogleTagManager GoogleTagManager { get; set; } = new();
+
+	[YamlMember(Alias = "feature_flags")]
+	public Dictionary<string, bool> FeatureFlags { get; set; } = [];
 }

src/Elastic.Documentation.Configuration/Builder/FeatureFlags.cs

@@ -4,10 +4,28 @@
 
 namespace Elastic.Documentation.Configuration.Builder;
 
-public class FeatureFlags(Dictionary<string, bool> featureFlags)
+public class FeatureFlags(Dictionary<string, bool> initFeatureFlags)
 {
-	public bool IsPrimaryNavEnabled => IsEnabled("primary-nav");
-	public bool IsVersionDropdownEnabled => IsEnabled("version-dropdown");
+	private readonly Dictionary<string, bool> _featureFlags = new(initFeatureFlags);
+
+	public void Set(string key, bool value)
+	{
+		var normalizedKey = key.ToLowerInvariant().Replace('_', '-');
+		_featureFlags[normalizedKey] = value;
+	}
+
+	public bool PrimaryNavEnabled
+	{
+		get => IsEnabled("primary-nav");
+		set => _featureFlags["primary-nav"] = value;
+	}
+
+	public bool VersionDropdownEnabled
+	{
+		get => IsEnabled("version-dropdown");
+		set => _featureFlags["version-dropdown"] = value;
+	}
+
 	private bool IsEnabled(string key)
 	{
 		var envKey = $"FEATURE_{key.ToUpperInvariant().Replace('-', '_')}";
@@ -18,6 +36,7 @@ private bool IsEnabled(string key)
 			// if the env var is set but not a bool, we treat it as enabled
 			return true;
 		}
-		return featureFlags.TryGetValue(key, out var value) && value;
+
+		return _featureFlags.TryGetValue(key, out var value) && value;
 	}
 }

src/Elastic.Documentation.Site/Layout/_Header.cshtml

@@ -1,5 +1,5 @@
 @inherits RazorSlice<Elastic.Documentation.Site.GlobalLayoutViewModel>
-@if (Model.Features.IsPrimaryNavEnabled)
+@if (Model.Features.PrimaryNavEnabled)
 {
 	<div id="elastic-nav"></div>
 	<script src="https://www.elastic.co/elastic-nav.js"></script>

src/Elastic.Documentation.Site/Navigation/IsolatedBuildNavigationHtmlWriter.cs

@@ -14,7 +14,7 @@ public class IsolatedBuildNavigationHtmlWriter(BuildContext context, IRootNaviga
 
 	public async Task<string> RenderNavigation(IRootNavigationItem<INavigationModel, INavigationItem> currentRootNavigation, Uri navigationSource, Cancel ctx = default)
 	{
-		var navigation = context.Configuration.Features.IsPrimaryNavEnabled || currentRootNavigation.IsUsingNavigationDropdown
+		var navigation = context.Configuration.Features.PrimaryNavEnabled || currentRootNavigation.IsUsingNavigationDropdown
 			? currentRootNavigation
 			: siteRoot;
 
@@ -33,8 +33,8 @@ private NavigationViewModel CreateNavigationModel(IRootNavigationItem<INavigatio
 			Title = navigation.NavigationTitle,
 			TitleUrl = navigation.Url,
 			Tree = navigation,
-			IsPrimaryNavEnabled = context.Configuration.Features.IsPrimaryNavEnabled,
-			IsUsingNavigationDropdown = context.Configuration.Features.IsPrimaryNavEnabled || navigation.IsUsingNavigationDropdown,
+			IsPrimaryNavEnabled = context.Configuration.Features.PrimaryNavEnabled,
+			IsUsingNavigationDropdown = context.Configuration.Features.PrimaryNavEnabled || navigation.IsUsingNavigationDropdown,
 			IsGlobalAssemblyBuild = false,
 			TopLevelItems = siteRoot.NavigationItems.OfType<INodeNavigationItem<INavigationModel, INavigationItem>>().ToList()
 		};

src/Elastic.Markdown/Slices/Layout/_Breadcrumbs.cshtml

@@ -1,7 +1,7 @@
 @inherits RazorSlice<MarkdownLayoutViewModel>
 @{
 	var targets =
-		Model.Features.IsPrimaryNavEnabled
+		Model.Features.PrimaryNavEnabled
 			? Model.Parents.Reverse()
 			: Model.Parents.Reverse().Skip(1);
 
@@ -12,29 +12,17 @@
 }
 
 <ol id="breadcrumbs" class="block items-center w-full py-6" itemscope="" itemtype="https://schema.org/BreadcrumbList">
-	<li class="inline text-ink-light text-sm leading-[1.2em]" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem">
-		<a
-			itemprop="item"
-			href="@Model.Link("/")"
-		>
-			<span itemprop="name" class="hover:text-black">
-				Docs
-			</span>
-		</a>
-		<meta itemprop="position" content="1">
-	</li>
 	@if (firstCrumb != null)
 	{
 		<li class="inline text-ink-light text-sm leading-[1.2em]" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem">
-			<span class="px-1">/</span>
 			<a
 				itemprop="item"
 				href="@firstCrumb.Url"
 				@Htmx.GetHxAttributes(firstCrumb.Url, Model.CurrentNavigationItem?.NavigationRoot.Id == firstCrumb.NavigationRoot.Id)
 			>
 				<span itemprop="name" class="hover:text-black">@firstCrumb.NavigationTitle</span>
 			</a>
-			<meta itemprop="position" content="2">
+			<meta itemprop="position" content="1">
 		</li>
 	}
 	@if (crumbs.Count > 0 && parents.Count > 3)
@@ -57,7 +45,7 @@
 			>
 				<span itemprop="name" class="hover:text-black">@item.NavigationTitle</span>
 			</a>
-			<meta itemprop="position" content="@(i+3)">
+			<meta itemprop="position" content="@(i+2)">
 		</li>
 	}
 	<li class="inline text-ink-light text-sm leading-[1.2em]" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem">

src/Elastic.Markdown/Slices/Layout/_TableOfContents.cshtml

@@ -1,7 +1,7 @@
 @inherits RazorSlice<MarkdownLayoutViewModel>
 <aside class="sidebar hidden lg:block max-w-65 md:hidden">
 	<nav id="toc-nav" class="sidebar-nav h-full">
-		@if (Model.Features.IsVersionDropdownEnabled)
+		@if (Model.Features.VersionDropdownEnabled)
 		{
 			<div class="mt-6">
 				<version-dropdown all-versions-url="@Model.AllVersionsUrl" current-version='@(Model.CurrentVersion)' items='@(new HtmlString(Model.VersionDropdownSerializedModel))' />

src/tooling/docs-assembler/Building/AssemblerBuilder.cs

@@ -30,6 +30,8 @@ public class AssemblerBuilder(
 	ILegacyUrlMapper? legacyUrlMapper
 )
 {
+	private readonly ILogger<AssemblerBuilder> _logger = logger.CreateLogger<AssemblerBuilder>();
+
 	private GlobalNavigationHtmlWriter HtmlWriter { get; } = writer;
 
 	private ILegacyUrlMapper? LegacyUrlMapper { get; } = legacyUrlMapper;
@@ -118,6 +120,7 @@ string Resolve(string relativeMarkdownPath)
 
 	private async Task<GenerationResult> BuildAsync(AssemblerDocumentationSet set, bool noop, IMarkdownExporter[]? markdownExporters, Cancel ctx)
 	{
+		SetFeatureFlags(set);
 		var generator = new DocumentationGenerator(
 			set.DocumentationSet,
 			logger, HtmlWriter,
@@ -130,4 +133,14 @@ private async Task<GenerationResult> BuildAsync(AssemblerDocumentationSet set, b
 		return await generator.GenerateAll(ctx);
 	}
 
+	private void SetFeatureFlags(AssemblerDocumentationSet set)
+	{
+		// Enable primary nav by default
+		set.DocumentationSet.Configuration.Features.PrimaryNavEnabled = true;
+		foreach (var configurationFeatureFlag in set.AssembleContext.Environment.FeatureFlags)
+		{
+			_logger.LogInformation("Setting feature flag: {ConfigurationFeatureFlagKey}={ConfigurationFeatureFlagValue}", configurationFeatureFlag.Key, configurationFeatureFlag.Value);
+			set.DocumentationSet.Configuration.Features.Set(configurationFeatureFlag.Key, configurationFeatureFlag.Value);
+		}
+	}
 }

src/tooling/docs-assembler/assembler.yml

@@ -23,6 +23,8 @@ environments:
     content_source: next
     google_tag_manager:
       enabled: false
+    feature_flags:
+      VERSION_DROPDOWN: true
   dev:
     uri: http://localhost:4000
     content_source: next