Skip to content

Commit 19e2f36

Browse files
committed
remove product metadata tags from the cumulative docs
1 parent edc54a8 commit 19e2f36

File tree

2 files changed

+5
-24
lines changed

2 files changed

+5
-24
lines changed

docs/contribute/cumulative-docs.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,12 @@ This tagging system is mandatory for all of the public-facing documentation. We
3535

3636
All documentation pages **must** include an `applies_to` tag in the YAML frontmatter. Use YAML frontmatter to indicate each deployment target's availability and lifecycle status.
3737

38-
* The `applies_to` attribute is used to display contextual badges on each page.
39-
* The `products` attribute is used by the search to let users filter their results when searching the docs.
38+
The `applies_to` attribute is used to display contextual badges on each page. For the full list of supported keys and values, refer to [frontmatter](https://elastic.github.io/docs-builder/syntax/frontmatter).
4039

41-
For the full list of supported keys and values, refer to [frontmatter](https://elastic.github.io/docs-builder/syntax/frontmatter).
4240

41+
:::{tip}
42+
Docs V3 frontmatter also supports a `products` attribute. This attribute is not surfaced to users on docs pages. Instead, it's used by the elastic.co search to let users filter their docs search results.
43+
:::
4344

4445
:::{include} /syntax/_snippets/page-level-applies-examples.md
4546
:::

docs/syntax/_snippets/page-level-applies-examples.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ There are 3 typical scenarios to start from:
77
applies_to:
88
stack: ga
99
serverless: ga
10-
products:
11-
- id: kibana
12-
- id: elasticsearch
13-
- id: elastic-stack
1410
---
1511
```
1612

@@ -24,11 +20,6 @@ There are 3 typical scenarios to start from:
2420
ess: ga
2521
ece: ga
2622
eck: ga
27-
products:
28-
- id: cloud-serverless
29-
- id: cloud-hosted
30-
- id: cloud-enterprise
31-
- id: cloud-kubernetes
3223
---
3324
3425
```
@@ -38,12 +29,9 @@ There are 3 typical scenarios to start from:
3829
```yml
3930
---
4031
applies_to:
41-
product: ga
42-
products:
43-
- id: edot-collector
32+
edot_ios: ga
4433
---
4534
```
46-
% changing soon
4735

4836
It can happen that it’s relevant to identify several or all of these dimensions for a page. Use your own judgement and check existing pages in similar contexts.
4937

@@ -56,14 +44,6 @@ applies_to:
5644
ess: ga
5745
ece: ga
5846
eck: ga
59-
products:
60-
- id: kibana
61-
- id: elasticsearch
62-
- id: elastic-stack
63-
- id: cloud-serverless
64-
- id: cloud-hosted
65-
- id: cloud-enterprise
66-
- id: cloud-kubernetes
6747
---
6848
```
6949
% I don't know what this example is supposed to show

0 commit comments

Comments
 (0)