Skip to content

Use planned instead of coming in applies_to tags #1220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2025
Merged

Use planned instead of coming in applies_to tags #1220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b057437
Use planned instead of coming in applies_to tags
Mpdreamz May 6, 2025
0b7f37b
update YamlAlias
Mpdreamz May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/syntax/applies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -30,7 +30,7 @@ Taking a mandatory [life-cycle](#life-cycle) with an optional version.
* `beta`
* `development`
* `deprecated`
* `coming`
* `planned`
* `discontinued`
* `unavailable`
* `ga`
Expand All @@ -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
```
Expand Down Expand Up @@ -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
---
```

Expand All @@ -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
Expand Down
7 changes: 4 additions & 3 deletions src/Elastic.Markdown/Myst/FrontMatter/Applicability.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ public enum ProductLifecycle
[YamlMember(Alias = "deprecated")]
Deprecated,
// coming (ditto)
[YamlMember(Alias = "coming")]
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")]
Discontinued,
Expand Down
15 changes: 13 additions & 2 deletions tests/authoring/Applicability/AppliesToFrontMatter.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,26 @@ applies_to:
)
))

type ``parses product`` () =
type ``parses product coming DEPRECATED`` () =
static let markdown = frontMatter """
applies_to:
product: coming 9.5
"""
[<Fact>]
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
"""
[<Fact>]
let ``apply matches expected`` () =
markdown |> appliesTo (ApplicableTo(
Product=AppliesCollection.op_Explicit "planned 9.5.0"
))

type ``parses product multiple`` () =
Expand Down
Loading