From b057437bdf945081718384ae2320db8ecd7297d5 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Tue, 6 May 2025 18:14:34 +0200 Subject: [PATCH 1/2] Use planned instead of coming in applies_to tags --- docs/syntax/applies.md | 10 +++++----- .../Myst/FrontMatter/Applicability.cs | 7 ++++--- .../Myst/FrontMatter/ProductLifecycle.cs | 2 +- .../Applicability/AppliesToFrontMatter.fs | 15 +++++++++++++-- 4 files changed, 23 insertions(+), 11 deletions(-) diff --git a/docs/syntax/applies.md b/docs/syntax/applies.md index adc576492..fafffc829 100644 --- a/docs/syntax/applies.md +++ b/docs/syntax/applies.md @@ -10,7 +10,7 @@ applies_to: security: ga 9.0.0 elasticsearch: beta 9.1.0 observability: discontinued 9.2.0 - product: coming 9.5, discontinued 9.7 + product: planned 9.5, discontinued 9.7 --- # Applies to @@ -30,7 +30,7 @@ Taking a mandatory [life-cycle](#life-cycle) with an optional version. * `beta` * `development` * `deprecated` - * `coming` + * `planned` * `discontinued` * `unavailable` * `ga` @@ -42,7 +42,7 @@ Can be in either `major.minor` or `major.minor.patch` format #### Examples ``` -coming 9.5, discontinued 9.7 +planned 9.5, discontinued 9.7 discontinued 9.2.0 all ``` @@ -107,7 +107,7 @@ applies_to: security: ga 9.0.0 elasticsearch: beta 9.1.0 observability: discontinued 9.2.0 - product: coming 9.5, discontinued 9.7 + product: planned 9.5, discontinued 9.7 --- ``` @@ -125,7 +125,7 @@ serverless: security: ga 9.0.0 elasticsearch: beta 9.1.0 observability: discontinued 9.2.0 -product: coming 9.5, discontinued 9.7 +product: planned 9.5, discontinued 9.7 ``` A header may be followed by an `{applies_to}` directive which will contextualize the applicability diff --git a/src/Elastic.Markdown/Myst/FrontMatter/Applicability.cs b/src/Elastic.Markdown/Myst/FrontMatter/Applicability.cs index 098acc75a..043eca238 100644 --- a/src/Elastic.Markdown/Myst/FrontMatter/Applicability.cs +++ b/src/Elastic.Markdown/Myst/FrontMatter/Applicability.cs @@ -108,7 +108,7 @@ public string GetLifeCycleName() => ProductLifecycle.Beta => "Beta", ProductLifecycle.Development => "Development", ProductLifecycle.Deprecated => "Deprecated", - ProductLifecycle.Coming => "Coming", + ProductLifecycle.Planned => "Planned", ProductLifecycle.Discontinued => "Discontinued", ProductLifecycle.Unavailable => "Unavailable", ProductLifecycle.GenerallyAvailable => "GA", @@ -127,7 +127,7 @@ public override string ToString() ProductLifecycle.Beta => "beta", ProductLifecycle.Development => "dev", ProductLifecycle.Deprecated => "deprecated", - ProductLifecycle.Coming => "coming", + ProductLifecycle.Planned => "planned", ProductLifecycle.Discontinued => "discontinued", ProductLifecycle.Unavailable => "unavailable", ProductLifecycle.GenerallyAvailable => "ga", @@ -168,7 +168,8 @@ public static bool TryParse(string? value, [NotNullWhen(true)] out Applicability "dev" => ProductLifecycle.Development, "development" => ProductLifecycle.Development, "deprecated" => ProductLifecycle.Deprecated, - "coming" => ProductLifecycle.Coming, + "coming" => ProductLifecycle.Planned, + "planned" => ProductLifecycle.Planned, "discontinued" => ProductLifecycle.Discontinued, "unavailable" => ProductLifecycle.Unavailable, "ga" => ProductLifecycle.GenerallyAvailable, diff --git a/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs b/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs index 8ce224fd5..7e175c575 100644 --- a/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs +++ b/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs @@ -23,7 +23,7 @@ public enum ProductLifecycle Deprecated, // coming (ditto) [YamlMember(Alias = "coming")] - Coming, + Planned, // discontinued (historically we've immediately removed content when the feature ceases to be supported, but this might not be the case with pages that contain information that spans versions) [YamlMember(Alias = "discontinued")] Discontinued, diff --git a/tests/authoring/Applicability/AppliesToFrontMatter.fs b/tests/authoring/Applicability/AppliesToFrontMatter.fs index fe7e1b311..7932d3b14 100644 --- a/tests/authoring/Applicability/AppliesToFrontMatter.fs +++ b/tests/authoring/Applicability/AppliesToFrontMatter.fs @@ -120,7 +120,7 @@ applies_to: ) )) -type ``parses product`` () = +type ``parses product coming DEPRECATED`` () = static let markdown = frontMatter """ applies_to: product: coming 9.5 @@ -128,7 +128,18 @@ applies_to: [] let ``apply matches expected`` () = markdown |> appliesTo (ApplicableTo( - Product=AppliesCollection.op_Explicit "coming 9.5.0" + Product=AppliesCollection.op_Explicit "planned 9.5.0" + )) + +type ``parses product planned`` () = + static let markdown = frontMatter """ +applies_to: + product: planned 9.5 +""" + [] + let ``apply matches expected`` () = + markdown |> appliesTo (ApplicableTo( + Product=AppliesCollection.op_Explicit "planned 9.5.0" )) type ``parses product multiple`` () = From 0b7f37be5a2438cd6146be4934877fb2019a52ec Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Tue, 6 May 2025 18:18:38 +0200 Subject: [PATCH 2/2] update YamlAlias --- src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs b/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs index 7e175c575..761844495 100644 --- a/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs +++ b/src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs @@ -22,7 +22,7 @@ public enum ProductLifecycle [YamlMember(Alias = "deprecated")] Deprecated, // coming (ditto) - [YamlMember(Alias = "coming")] + [YamlMember(Alias = "planned")] Planned, // discontinued (historically we've immediately removed content when the feature ceases to be supported, but this might not be the case with pages that contain information that spans versions) [YamlMember(Alias = "discontinued")]