Skip to content

Commit 17858c5

Browse files
Copilottheletterf
andauthored
Add description metadata to first-level index pages (#3395)
## Summary This PR adds `description` metadata to the frontmatter of all 10 first-level index.md files in the repository to improve SEO and provide clear page summaries. ## Changes Added concise, informative descriptions to the following first-level index pages: - **cloud-account/index.md** - Description about managing Elastic Cloud account settings and preferences - **deploy-manage/index.md** - Description about deploying and managing Elastic environments - **explore-analyze/index.md** - Description about exploring and analyzing data with Kibana - **extend/index.md** - Description about extending the Elastic Platform (also added frontmatter structure) - **get-started/index.md** - Description about Elastic fundamentals and getting started - **manage-data/index.md** - Description about data ingestion and management in Elasticsearch - **reference/index.md** - Description about Elastic Stack reference documentation - **release-notes/index.md** - Description about release notes and changelogs (also added frontmatter structure) - **solutions/index.md** - Description about Elastic solutions for search, observability, and security - **troubleshoot/index.md** - Description about troubleshooting resources and support ## Implementation Details - All descriptions follow the YAML multi-line format consistent with the root `index.md` file - Descriptions are concise (2-3 sentences) and accurately reflect the content of each page - Two files (`extend/index.md` and `release-notes/index.md`) previously had no frontmatter and now have proper YAML frontmatter blocks - All YAML syntax has been validated ## Related Issue Addresses the requirement outlined in elastic/docs-builder#1559 ## Example Before: ```yaml --- applies_to: stack: ga serverless: ga --- ``` After: ```yaml --- applies_to: stack: ga serverless: ga description: Learn how to ingest, store, and manage data in Elasticsearch. Understand indices, mappings, text analysis, data lifecycle management, and migration between clusters. --- ``` <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>Add description metadata to first-level index pages</issue_title> > <issue_description>Most Markdown docs in this repository still lack a `description:` in the frontmatter. We should at least add a description for the first level pages, that is, the index.md pages inside each of the docs folders. > > Related issue: https://github.com/elastic/docs-builder/issues/1559</issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> Fixes #3394 <!-- START COPILOT CODING AGENT TIPS --> --- 💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click [here](https://survey3.medallia.com/?EAHeSx-AP01bZqG0Ld9QLQ) to start the survey. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: theletterf <[email protected]>
1 parent 546366d commit 17858c5

File tree

10 files changed

+36
-0
lines changed

10 files changed

+36
-0
lines changed

cloud-account/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ applies_to:
99
products:
1010
- id: cloud-hosted
1111
- id: cloud-serverless
12+
description: Manage your Elastic Cloud account settings, including email, password,
13+
authentication methods, and personal preferences. Configure your user profile
14+
and customize your interface.
1215
---
1316

1417
# Manage your Cloud account and preferences

deploy-manage/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ products:
99
- id: kibana
1010
- id: cloud-hosted
1111
- id: cloud-enterprise
12+
description: Deploy and manage your Elastic environment. Learn how to design resilient
13+
clusters, secure access, monitor performance, and maintain your Elastic Stack
14+
components across different deployment options.
1215
---
1316

1417
# Deploy and manage

explore-analyze/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ applies_to:
1111
products:
1212
- id: cloud-serverless
1313
- id: kibana
14+
description: Explore and analyze your data with Kibana. Query, filter, visualize,
15+
and create interactive dashboards to gain insights from your Elasticsearch data.
16+
Utilize machine learning, geospatial analysis, and more.
1417
---
1518

1619
# Explore and analyze data with Kibana

extend/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description: Extend the Elastic Platform by creating integrations for data ingestion
3+
or building custom applications with REST APIs. Learn how to contribute to Elastic
4+
documentation and ecosystem.
5+
---
6+
17
# Extend and contribute
28

39
You can extend and build on the Elastic Platform in several ways. Whether you need to get data into Elasticsearch, add new functionality, edit the documentation, or build a custom application, here is an overview of the primary development paths to help you choose the right one for your project.

get-started/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ products:
1212
applies_to:
1313
serverless:
1414
stack:
15+
description: Learn the fundamentals of Elastic. Discover what Elastic offers, explore
16+
core concepts of the Elastic Stack, understand deployment options, and access
17+
training resources to get started.
1518
---
1619

1720
# Elastic fundamentals

manage-data/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
applies_to:
33
stack: ga
44
serverless: ga
5+
description: Learn how to ingest, store, and manage data in Elasticsearch. Understand
6+
indices, mappings, text analysis, data lifecycle management, and data migration between
7+
clusters.
58
---
69

710
# Manage data

reference/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html
44
products:
55
- id: elastic-stack
6+
description: Explore reference documentation for the Elastic Stack including APIs,
7+
security schemas, configuration settings, query languages, scripting, ECS field
8+
references, and more.
69
---
710

811
# Reference [api-reference]

release-notes/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
---
2+
description: Release notes and changelogs for Elastic products including Elasticsearch,
3+
Kibana, Observability, Security, APM agents, and clients. Stay updated with new
4+
features and changes.
5+
---
6+
17
# Release notes

solutions/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ applies_to:
66
serverless: ga
77
products:
88
- id: cloud-hosted
9+
description: Learn about Elastic solutions for search, observability, and security
10+
use cases. Get started with ready-to-use implementations and discover how to build
11+
custom applications.
912
---
1013

1114
# Solutions and use cases

troubleshoot/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ products:
1010
- id: elastic-stack
1111
- id: cloud-hosted
1212
- id: cloud-enterprise
13+
description: Troubleshooting resources and guidance for Elastic products including
14+
Elasticsearch, Kibana, Observability, Security, and deployment platforms. Find
15+
solutions and get support.
1316
---
1417

1518
# Troubleshooting

0 commit comments

Comments
 (0)