Skip to content

Commit a9c0a08

Browse files
authored
Use planned instead of coming in applies_to tags (#1220)
* Use planned instead of coming in applies_to tags * update YamlAlias
1 parent 25cf121 commit a9c0a08

File tree

4 files changed

+24
-12
lines changed

4 files changed

+24
-12
lines changed

docs/syntax/applies.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ applies_to:
1010
security: ga 9.0.0
1111
elasticsearch: beta 9.1.0
1212
observability: discontinued 9.2.0
13-
product: coming 9.5, discontinued 9.7
13+
product: planned 9.5, discontinued 9.7
1414
---
1515

1616
# Applies to
@@ -30,7 +30,7 @@ Taking a mandatory [life-cycle](#life-cycle) with an optional version.
3030
* `beta`
3131
* `development`
3232
* `deprecated`
33-
* `coming`
33+
* `planned`
3434
* `discontinued`
3535
* `unavailable`
3636
* `ga`
@@ -42,7 +42,7 @@ Can be in either `major.minor` or `major.minor.patch` format
4242
#### Examples
4343

4444
```
45-
coming 9.5, discontinued 9.7
45+
planned 9.5, discontinued 9.7
4646
discontinued 9.2.0
4747
all
4848
```
@@ -107,7 +107,7 @@ applies_to:
107107
security: ga 9.0.0
108108
elasticsearch: beta 9.1.0
109109
observability: discontinued 9.2.0
110-
product: coming 9.5, discontinued 9.7
110+
product: planned 9.5, discontinued 9.7
111111
---
112112
```
113113

@@ -125,7 +125,7 @@ serverless:
125125
security: ga 9.0.0
126126
elasticsearch: beta 9.1.0
127127
observability: discontinued 9.2.0
128-
product: coming 9.5, discontinued 9.7
128+
product: planned 9.5, discontinued 9.7
129129
```
130130

131131
A header may be followed by an `{applies_to}` directive which will contextualize the applicability

src/Elastic.Markdown/Myst/FrontMatter/Applicability.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public string GetLifeCycleName() =>
108108
ProductLifecycle.Beta => "Beta",
109109
ProductLifecycle.Development => "Development",
110110
ProductLifecycle.Deprecated => "Deprecated",
111-
ProductLifecycle.Coming => "Coming",
111+
ProductLifecycle.Planned => "Planned",
112112
ProductLifecycle.Discontinued => "Discontinued",
113113
ProductLifecycle.Unavailable => "Unavailable",
114114
ProductLifecycle.GenerallyAvailable => "GA",
@@ -127,7 +127,7 @@ public override string ToString()
127127
ProductLifecycle.Beta => "beta",
128128
ProductLifecycle.Development => "dev",
129129
ProductLifecycle.Deprecated => "deprecated",
130-
ProductLifecycle.Coming => "coming",
130+
ProductLifecycle.Planned => "planned",
131131
ProductLifecycle.Discontinued => "discontinued",
132132
ProductLifecycle.Unavailable => "unavailable",
133133
ProductLifecycle.GenerallyAvailable => "ga",
@@ -168,7 +168,8 @@ public static bool TryParse(string? value, [NotNullWhen(true)] out Applicability
168168
"dev" => ProductLifecycle.Development,
169169
"development" => ProductLifecycle.Development,
170170
"deprecated" => ProductLifecycle.Deprecated,
171-
"coming" => ProductLifecycle.Coming,
171+
"coming" => ProductLifecycle.Planned,
172+
"planned" => ProductLifecycle.Planned,
172173
"discontinued" => ProductLifecycle.Discontinued,
173174
"unavailable" => ProductLifecycle.Unavailable,
174175
"ga" => ProductLifecycle.GenerallyAvailable,

src/Elastic.Markdown/Myst/FrontMatter/ProductLifecycle.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ public enum ProductLifecycle
2222
[YamlMember(Alias = "deprecated")]
2323
Deprecated,
2424
// coming (ditto)
25-
[YamlMember(Alias = "coming")]
26-
Coming,
25+
[YamlMember(Alias = "planned")]
26+
Planned,
2727
// 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)
2828
[YamlMember(Alias = "discontinued")]
2929
Discontinued,

tests/authoring/Applicability/AppliesToFrontMatter.fs

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,26 @@ applies_to:
120120
)
121121
))
122122

123-
type ``parses product`` () =
123+
type ``parses product coming DEPRECATED`` () =
124124
static let markdown = frontMatter """
125125
applies_to:
126126
product: coming 9.5
127127
"""
128128
[<Fact>]
129129
let ``apply matches expected`` () =
130130
markdown |> appliesTo (ApplicableTo(
131-
Product=AppliesCollection.op_Explicit "coming 9.5.0"
131+
Product=AppliesCollection.op_Explicit "planned 9.5.0"
132+
))
133+
134+
type ``parses product planned`` () =
135+
static let markdown = frontMatter """
136+
applies_to:
137+
product: planned 9.5
138+
"""
139+
[<Fact>]
140+
let ``apply matches expected`` () =
141+
markdown |> appliesTo (ApplicableTo(
142+
Product=AppliesCollection.op_Explicit "planned 9.5.0"
132143
))
133144

134145
type ``parses product multiple`` () =

0 commit comments

Comments
 (0)