Commit 17858c5
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
10 files changed
+36
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
12 | 15 | | |
13 | 16 | | |
14 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
12 | 15 | | |
13 | 16 | | |
14 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
14 | 17 | | |
15 | 18 | | |
16 | 19 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
1 | 7 | | |
2 | 8 | | |
3 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
15 | 18 | | |
16 | 19 | | |
17 | 20 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
5 | 8 | | |
6 | 9 | | |
7 | 10 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
6 | 9 | | |
7 | 10 | | |
8 | 11 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
1 | 7 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
9 | 12 | | |
10 | 13 | | |
11 | 14 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
13 | 16 | | |
14 | 17 | | |
15 | 18 | | |
| |||
0 commit comments