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]

‎deploy-manage/api-keys/serverless-project-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-
serverless: ga
42
mapped_pages:
53
- https://www.elastic.co/guide/en/serverless/current/api-keys.html
4+
applies_to:
5+
serverless: ga
6+
products:
7+
- id: cloud-serverless
68
---
79

810
# Serverless project API keys [api-keys]

‎deploy-manage/autoscaling.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ applies_to:
77
ess: ga
88
eck: ga
99
serverless: all
10+
products:
11+
- id: elasticsearch
1012
---
1113

1214
# Autoscaling

‎deploy-manage/autoscaling/autoscaling-deciders.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ mapped_pages:
99
- https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-machine-learning-decider.html
1010
- https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-fixed-decider.html
1111
applies_to:
12-
ece:
13-
eck:
14-
ess:
12+
deployment:
13+
ece:
14+
eck:
15+
ess:
16+
products:
17+
- id: elasticsearch
1518
---
1619

1720
# Autoscaling deciders [autoscaling-deciders]

‎deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
navigation_title: In ECE and ECH
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-autoscaling.html
45
- https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html
@@ -12,7 +13,9 @@ applies_to:
1213
deployment:
1314
ece: ga
1415
ess: ga
15-
navigation_title: "In ECE and ECH"
16+
products:
17+
- id: cloud-hosted
18+
- id: cloud-enterprise
1619
---
1720

1821
# Autoscaling in {{ece}} and {{ech}}

‎deploy-manage/autoscaling/autoscaling-in-eck.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2+
navigation_title: In ECK
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-autoscaling.html
45
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-stateless-autoscaling.html
56
applies_to:
67
deployment:
78
eck: ga
8-
navigation_title: "In ECK"
9+
products:
10+
- id: cloud-kubernetes
911
---
1012
# Autoscaling in {{eck}}
1113

‎deploy-manage/autoscaling/trained-model-autoscaling.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ applies_to:
88
eck:
99
ece:
1010
serverless:
11+
products:
12+
- id: cloud-serverless
13+
- id: machine-learning
1114
---
1215

1316
# Trained model autoscaling

‎deploy-manage/cloud-organization.md

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

1012
# Manage your Cloud organization [ec-organizations]

‎deploy-manage/cloud-organization/billing.md

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

1215
# Billing

‎deploy-manage/cloud-organization/billing/add-billing-details.md

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

1012
# Add your billing details [ec-billing-details]

‎deploy-manage/cloud-organization/billing/billing-faq.md

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

1012
# Billing FAQ [ec-faq-billing]

‎deploy-manage/cloud-organization/billing/billing-models.md

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

1012
# Billing models [ec-billing-models]

‎deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
navigation_title: "Hosted billing dimensions"
2+
navigation_title: Hosted billing dimensions
33
mapped_pages:
44
- https://www.elastic.co/guide/en/cloud/current/ec-billing-dimensions.html
55
applies_to:
66
deployment:
77
ess: all
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# Cloud Hosted deployment billing dimensions [ec-billing-dimensions]

‎deploy-manage/cloud-organization/billing/ecu.md

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

1012
# Elastic Consumption Units [ec-billing-ecu]

‎deploy-manage/cloud-organization/billing/elastic-observability-billing-dimensions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
navigation_title: "Elastic for Observability"
2+
navigation_title: Elastic for Observability
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/observability-billing.html
55
applies_to:
66
serverless: all
7+
products:
8+
- id: cloud-serverless
79
---
810

911
# Elastic for Observability billing dimensions [observability-billing]

‎deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
navigation_title: "Elasticsearch"
2+
navigation_title: Elasticsearch
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/elasticsearch-billing.html
55
applies_to:
66
serverless: all
7+
products:
8+
- id: cloud-serverless
79
---
810

911
# {{es}} billing dimensions [elasticsearch-billing]

‎deploy-manage/cloud-organization/billing/manage-subscription.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ applies_to:
99
deployment:
1010
ess: all
1111
serverless: all
12+
products:
13+
- id: cloud-serverless
14+
- id: cloud-hosted
1215
---
1316

1417
# Manage your subscription

‎deploy-manage/cloud-organization/billing/monitor-analyze-usage.md

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

1114
# Monitor and analyze usage

‎deploy-manage/cloud-organization/billing/security-billing-dimensions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
navigation_title: "Elastic for Security"
2+
navigation_title: Elastic for Security
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/security-billing.html
55
applies_to:
66
serverless: all
7+
products:
8+
- id: cloud-serverless
79
---
810

911
# Elastic for Security billing dimensions [security-billing]

‎deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
navigation_title: "Serverless billing dimensions"
2+
navigation_title: Serverless billing dimensions
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/general-serverless-billing.html
55
applies_to:
66
serverless: all
7+
products:
8+
- id: cloud-serverless
79
---
810

911
# Serverless project billing dimensions [general-serverless-billing]

‎deploy-manage/cloud-organization/billing/update-billing-operational-contacts.md

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

1012
# Update billing and operational contacts [ec-billing-contacts]

‎deploy-manage/cloud-organization/billing/view-billing-history.md

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

1114
# View your billing history [ec-billing-history]

‎deploy-manage/cloud-organization/operational-emails.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ mapped_pages:
44
applies_to:
55
deployment:
66
ess: all
7+
products:
8+
- id: cloud-hosted
79
---
810

911
# Operational emails [ec-operational-emails]

‎deploy-manage/cloud-organization/service-status.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ applies_to:
1111
deployment:
1212
ess: all
1313
serverless: all
14+
products:
15+
- id: cloud-hosted
16+
- id: cloud-serverless
1417
---
1518

1619
# Service status

‎deploy-manage/cloud-organization/tools-and-apis.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2+
navigation_title: Tools and APIs
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud/current/ec-work-with-apis.html
4-
navigation_title: Tools and APIs
5+
products:
6+
- id: cloud-hosted
57
---
68

79
# Tools and APIs for your Cloud organization [ec-work-with-apis]
810

9-
You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your {{ecloud}} organization, members, costs, billing, and more.
11+
You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your {{ecloud}} organization, members, costs, billing, and more.
1012

1113
* Refer to [](/deploy-manage/api-keys/elastic-cloud-api-keys.md) to learn how to generate an API key to access this API.
1214
* Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples.

‎deploy-manage/deploy.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/serverless/current/intro.html
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
55
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/get-elastic.html
6+
products:
7+
- id: cloud-serverless
8+
- id: elasticsearch
9+
- id: elastic-stack
610
---
711

812
# Deploy

0 commit comments

Comments
 (0)