Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors and modernizes the Generic Data Index documentation by adding consistent front matter metadata, improving wording/structure, and expanding the “Extending Data Index” section with new guidance.
Changes:
- Added YAML front matter (
title,description, etc.) and standardized formatting across multiple docs. - Introduced new documentation for registering custom data object field definition adapters.
- Updated/rewrote several examples and reference sections for search, configuration, index management, PQL, and modifiers.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/05_Extending_Data_Index/README.md | Adds front matter and updates overview + links for the “Extending Data Index” section. |
| doc/05_Extending_Data_Index/07_Custom_Field_Definition_Adapters.md | New page documenting how to reuse/register field definition adapters. |
| doc/05_Extending_Data_Index/06_Extend_Search_Index.md | Adds front matter and refactors event-based extension examples. |
| doc/04_Searching_For_Data_In_Index/README.md | Refactors search service docs and examples; adds admonitions and clarifies sections. |
| doc/04_Searching_For_Data_In_Index/09_Pimcore_Query_Language/README.md | Adds front matter/keywords and restructures PQL reference content. |
| doc/04_Searching_For_Data_In_Index/09_Pimcore_Query_Language/03_Use_PQL_as_Developer.md | Adds front matter and improves developer-oriented PQL usage and exception handling guidance. |
| doc/04_Searching_For_Data_In_Index/08_Permissions_Workspaces/README.md | Adds front matter and clarifies permission/workspace behavior and events. |
| doc/04_Searching_For_Data_In_Index/06_Default_Search_Models/README.md | Adds front matter and refactors default search model docs/examples. |
| doc/04_Searching_For_Data_In_Index/05_Search_Modifiers/README.md | Adds front matter and reorganizes/standardizes modifier tables and explanations. |
| doc/02_Configuration/README.md | Adds front matter and clarifies configuration scope and related links. |
| doc/02_Configuration/05_Elasticsearch.md | Adds front matter and clarifies Elasticsearch setup + auto-index creation caveat. |
| doc/02_Configuration/04_Opensearch.md | Adds front matter and clarifies OpenSearch setup + auto-index creation caveat. |
| doc/02_Configuration/03_Index_Management.md | Adds front matter and reorganizes index management guidance and command references. |
| doc/01_Installation/README.md | Adds front matter and refreshes installation + deployment notes formatting. |
| doc/01_Installation/02_Upgrade.md | Adds front matter and restructures upgrade notes/breaking changes sections. |
| README.md | Minor grammar/punctuation correction. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
doc/05_Extending_Data_Index/07_Custom_Field_Definition_Adapters.md
Outdated
Show resolved
Hide resolved
doc/04_Searching_For_Data_In_Index/05_Search_Modifiers/README.md
Outdated
Show resolved
Hide resolved
doc/04_Searching_For_Data_In_Index/05_Search_Modifiers/README.md
Outdated
Show resolved
Hide resolved
…s.md Co-authored-by: Copilot <[email protected]>
|
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.