From eb9048f62fd94f2e19ca1b84ca2b557ea6432f57 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Fri, 14 Mar 2025 17:44:41 +0100 Subject: [PATCH 1/2] Control allow index per environment, default to false --- src/docs-assembler/Building/AssemblerBuilder.cs | 2 +- src/docs-assembler/Configuration/AssemblyConfiguration.cs | 3 +++ src/docs-assembler/assembler.yml | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/docs-assembler/Building/AssemblerBuilder.cs b/src/docs-assembler/Building/AssemblerBuilder.cs index 89b473d6e..367ea0e83 100644 --- a/src/docs-assembler/Building/AssemblerBuilder.cs +++ b/src/docs-assembler/Building/AssemblerBuilder.cs @@ -58,7 +58,7 @@ private async Task BuildAsync(Checkout checkout, PublishEnvironment environment, StaticUrlPathPrefix = environment.PathPrefix, UrlPathPrefix = pathPrefix, Force = true, - AllowIndexing = true + AllowIndexing = environment.AllowIndexing }; var set = new DocumentationSet(buildContext, logger, crossLinkResolver); diff --git a/src/docs-assembler/Configuration/AssemblyConfiguration.cs b/src/docs-assembler/Configuration/AssemblyConfiguration.cs index 315b79516..9965d6663 100644 --- a/src/docs-assembler/Configuration/AssemblyConfiguration.cs +++ b/src/docs-assembler/Configuration/AssemblyConfiguration.cs @@ -89,4 +89,7 @@ public record PublishEnvironment [YamlMember(Alias = "path_prefix")] public string? PathPrefix { get; set; } = string.Empty; + + [YamlMember(Alias = "allow_index")] + public bool AllowIndexing { get; set; } } diff --git a/src/docs-assembler/assembler.yml b/src/docs-assembler/assembler.yml index 101afd011..b77dbbfc9 100644 --- a/src/docs-assembler/assembler.yml +++ b/src/docs-assembler/assembler.yml @@ -2,6 +2,7 @@ environments: production: uri: https://elastic.co path_prefix: docs + allow_index: false staging: uri: https://staging-website.elastic.co path_prefix: docs From fc0f9d38d8a0e943ca34138bd7339a1efaad66c8 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Fri, 14 Mar 2025 22:03:08 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Jan Calanog --- src/docs-assembler/Configuration/AssemblyConfiguration.cs | 2 +- src/docs-assembler/assembler.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/docs-assembler/Configuration/AssemblyConfiguration.cs b/src/docs-assembler/Configuration/AssemblyConfiguration.cs index 9965d6663..73c39734b 100644 --- a/src/docs-assembler/Configuration/AssemblyConfiguration.cs +++ b/src/docs-assembler/Configuration/AssemblyConfiguration.cs @@ -90,6 +90,6 @@ public record PublishEnvironment [YamlMember(Alias = "path_prefix")] public string? PathPrefix { get; set; } = string.Empty; - [YamlMember(Alias = "allow_index")] + [YamlMember(Alias = "allow_indexing")] public bool AllowIndexing { get; set; } } diff --git a/src/docs-assembler/assembler.yml b/src/docs-assembler/assembler.yml index b77dbbfc9..f65c5df7e 100644 --- a/src/docs-assembler/assembler.yml +++ b/src/docs-assembler/assembler.yml @@ -2,7 +2,7 @@ environments: production: uri: https://elastic.co path_prefix: docs - allow_index: false + allow_indexing: false staging: uri: https://staging-website.elastic.co path_prefix: docs