Skip to content

Commit baf3a86

Browse files
Fix typos
1 parent 3fd6e7d commit baf3a86

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

docs/syntax/applies.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Starting with Elastic Stack 9.0, ECE 4.0, and ECK 3.0, documentation follows a [cumulative approach](../contribute/index.md): instead of creating separate pages for each product and release, we update a single page with product- and version-specific details over time.
44

55
To support this, source files use a tagging system to indicate:
6-
Which Elastic products and deployment models the content applies to.
7-
When a feature changes state relative to the base version.
6+
* Which Elastic products and deployment models the content applies to.
7+
* When a feature changes state relative to the base version.
88

99
This is what the `applies_to` metadata is for. It can be used at the page, section, or inline level to specify applicability with precision.
1010

@@ -22,16 +22,14 @@ The `applies_to` metadata can be added at different levels in the documentation:
2222

2323
✅ Use `applies_to` tags to indicate which product or deployment type the content applies to. This is mandatory for every page.
2424

25-
✅ Use applies_to tags when features change state in a specific update or release.
25+
✅ Use `applies_to` tags when features change state in a specific update or release.
2626

2727
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
2828

2929
❌ You don’t need to tag every section or paragraph. Only do so if the context or applicability changes from what has been established earlier.
3030

3131
❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you do not need to tag a new GA feature.
3232

33-
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
34-
3533
## Syntax
3634

3735
```
@@ -77,7 +75,7 @@ applies_to:
7775
### Lifecycle examples
7876

7977
#### Unversioned products
80-
Unversioned products aren’t following a fixed versioning scheme and are released a lot more often than versioned products. All users are using the same version of this product.
78+
Unversioned products don't follow a fixed versioning scheme and are released a lot more often than versioned products. All users are using the same version of this product.
8179
* When a change is released in `ga`, it **doesn’t need any specific tagging**.
8280
* When a change is introduced as preview or beta, use `preview` or `beta` as value for the corresponding key within the `applies_to`:
8381

@@ -87,7 +85,7 @@ Unversioned products aren’t following a fixed versioning scheme and are releas
8785
serverless: preview
8886
---
8987
```
90-
* When a change introduces a deprecation, use deprecated as value for the corresponding key within the applies_to:
88+
* When a change introduces a deprecation, use deprecated as value for the corresponding key within the `applies_to`:
9189
9290
```
9391
---
@@ -162,7 +160,7 @@ applies_to:
162160
163161
### Page annotations
164162
165-
All documentation pages **must** include an `applies_to` tag in the YAML frontmatter. Use yaml frontmatter to indicate each deployment targets availability and lifecycle status. For a complete list of supported keys and values, see the [frontmatter syntax guide](./frontmatter.md).
163+
All documentation pages **must** include an `applies_to` tag in the YAML frontmatter. Use YAML frontmatter to indicate each deployment targets availability and lifecycle status. For a complete list of supported keys and values, see the [frontmatter syntax guide](./frontmatter.md).
166164
167165
#### Page annotation examples
168166
@@ -234,7 +232,7 @@ the `{applies_to}` directive **MUST** be preceded by a heading directly.
234232
:::
235233

236234

237-
Note that this directive needs triple backticks since its content is literal. See also [](index.md#literal-directives)
235+
Note that this directive requires triple backticks since its content is literal. See also [](index.md#literal-directives)
238236

239237
````markdown
240238
```{applies_to}
@@ -250,7 +248,7 @@ stack: ga 9.1
250248
```
251249
````
252250

253-
This will allow the yaml inside the `{applies_to}` directive to be fully highlighted.
251+
This will allow the YAML inside the `{applies_to}` directive to be fully highlighted.
254252

255253
#### Section annotation examples
256254

@@ -336,7 +334,7 @@ Property {preview}`<version>`
336334

337335
![Applies To Model](images/applies.png)
338336

339-
The above model is projected to the following structured yaml.
337+
The above model is projected to the following structured YAML.
340338

341339
```yaml
342340
---

0 commit comments

Comments
 (0)