Skip to content

Commit a4c1378

Browse files
colleenmcginnisKOTungseth
colleenmcginnis
and
KOTungseth
authored
Add products frontmatter (#1410)
⚠️ **This PR is dependent on elastic/docs-builder#1256 being merged and changes being released.** Related to #1336 elastic/docs-builder#1200 Adds new `products` frontmatter, which will be used to generate metadata during the build process that the web team will use in the search experience (so users can filter by product). _Note: This reduces the scope of #1336 to only include `products` tags in the frontmatter to unblock updates to the search experience. I'll open a separate PR to update `applies_to` and tag writers to review for their area._ Here's the process: * **Map AsciiDoc/v3 products**: @KOTungseth created a list of all AsciiDoc books mapped to product names. * **Add frontmatter**: I wrote a script that uses Kaarina's list to look at each Markdown file and assign `products` associated with the AsciiDoc book(s) included in `mapped_pages`. * **Format frontmatter**: I standardized the order and format of the frontmatter items. * **Validate frontmatter**: I created [`frontmatter.config.yml`](https://github.com/elastic/docs-content/blob/add-product-tags/frontmatter.config.yml) and checked against it to make sure all frontmatter keys and product values are valid. (Note: I haven't checked that all the values of `deployment` and `serverless` options are valid/correctly formatted.) cc @KOTungseth @reakaleek @zumwalt --------- Co-authored-by: Kaarina Tungseth <[email protected]>
1 parent 0f12490 commit a4c1378

File tree

1,983 files changed

+7288
-2674
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,983 files changed

+7288
-2674
lines changed

‎archive.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: archive
3-
description: Browse the archive for legacy Elastic products and documentation. Archive documentation is unmaintained and may be out-of-date.
3+
description: Browse the archive for legacy Elastic products and documentation.
4+
Archive documentation is unmaintained and may be out-of-date.
45
---
56

67
# Documentation archive

‎cloud-account/add-a-login-method.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ applies_to:
55
serverless: all
66
deployment:
77
ess: all
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# Add a login method [ec-change-login-method]

‎cloud-account/change-your-password.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ applies_to:
55
serverless: all
66
deployment:
77
ess: all
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# Change your password [ec-change-password]

‎cloud-account/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ applies_to:
66
serverless: all
77
deployment:
88
ess: all
9+
products:
10+
- id: cloud-hosted
11+
- id: cloud-serverless
912
---
1013

1114
# Manage your Cloud account and preferences

‎cloud-account/join-or-leave-an-organization.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ applies_to:
66
serverless: all
77
deployment:
88
ess: all
9+
products:
10+
- id: cloud-hosted
11+
- id: cloud-serverless
912
---
1013

1114
# Join or leave an organization

‎cloud-account/multifactor-authentication.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ applies_to:
55
serverless: all
66
deployment:
77
ess: all
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# Multifactor authentication [ec-account-security-mfa]

‎cloud-account/update-your-email-address.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ applies_to:
55
serverless: all
66
deployment:
77
ess: all
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# Update your email address [ec-update-email-address]

‎deploy-manage/api-keys/elastic-cloud-api-keys.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html
24
applies_to:
35
deployment:
46
ess: ga
57
serverless: ga
6-
mapped_pages:
7-
- https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# {{ecloud}} API keys [ec-api-authentication]

‎deploy-manage/api-keys/elastic-cloud-enterprise-api-keys.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-restful-api-authentication.html
24
applies_to:
35
deployment:
46
ece: ga
5-
mapped_pages:
6-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-restful-api-authentication.html
7+
products:
8+
- id: cloud-enterprise
79
---
810

911
# {{ece}} API keys [ece-restful-api-authentication]

‎deploy-manage/api-keys/elasticsearch-api-keys.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
applies_to:
3-
stack: ga
42
mapped_pages:
53
- https://www.elastic.co/guide/en/kibana/current/api-keys.html
4+
applies_to:
5+
stack: ga
6+
products:
7+
- id: kibana
68
---
79

810
# {{es}} API keys [api-keys]

0 commit comments

Comments
 (0)