Add description metadata to first-level index pages #3395
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: theletterf <[email protected]>
Copilot
AI
changed the title
[WIP] Add description metadata to first-level index pages
Add description metadata to first-level index pages
Oct 8, 2025
Copilot finished work on behalf of
theletterf
October 8, 2025 09:35
theletterf
approved these changes
Oct 8, 2025
florent-leborgne
approved these changes
Oct 8, 2025
Contributor
florent-leborgne
left a comment
florent-leborgne
left a comment
There was a problem hiding this comment.
Simple progress! Nice!
yetanothertw
reviewed
Oct 8, 2025
Co-authored-by: Vlada Chirmicci <[email protected]>
rhr323
pushed a commit
to rhr323/docs-content
that referenced
this pull request
Oct 27, 2025
## 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 elastic#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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds
descriptionmetadata 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:
Implementation Details
index.mdfileextend/index.mdandrelease-notes/index.md) previously had no frontmatter and now have proper YAML frontmatter blocksRelated Issue
Addresses the requirement outlined in elastic/docs-builder#1559
Example
Before:
After:
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.