[DOCS][9.x] Improve ESQL reference docs information architecture #127248
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
- reorganized es|ql reference documentation from flat list to logical hierarchy - created three main sections: language fundamentals, special fields, advanced operations - renamed pages with more consistent and task-oriented titles - updated toc.yml to reflect new hierarchical structure - aligned navigation titles with page content - improved introductory text for each section - used parallel phrasing for similar concepts - clarified the relationship between reference docs and conceptual docs
leemthompo
added
>docs
leemthompo
changed the title
elasticsearchmachine
added
the
Team:Analytics
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
alex-spies
approved these changes
Apr 24, 2025
There was a problem hiding this comment.
Thanks @leemthompo , looks good! I only left some minor remarks.
Co-authored-by: Alexander Spies <[email protected]>
…e guides
This diff updates the terminology and organization of the ESQL documentation to better reflect content purpose:
. Improves description on main ESQL page to be clearer and more future-proof
. Updates heading to "Advanced workflows in {{esql}}"
. Refines introduction text to emphasize these are guides, not just command references
leemthompo
added a commit
to leemthompo/elasticsearch
that referenced
this pull request
Apr 25, 2025
…stic#127248) * [DOCS][9.0] Improve ESQL reference docs IA - reorganized es|ql reference documentation from flat list to logical hierarchy - created three main sections: syntax reference , special fields, advanced operations - renamed pages with more consistent and task-oriented titles - aligned navigation titles with page content - improved introductory text for each section - used parallel phrasing for similar concepts - clarified the relationship between reference docs and conceptual docs Co-authored-by: Alexander Spies <[email protected]>
💚 Backport successful
|
leemthompo
added a commit
that referenced
this pull request
Apr 25, 2025
…7248) (#127380) * [DOCS][9.0] Improve ESQL reference docs IA - reorganized es|ql reference documentation from flat list to logical hierarchy - created three main sections: syntax reference , special fields, advanced operations - renamed pages with more consistent and task-oriented titles - aligned navigation titles with page content - improved introductory text for each section - used parallel phrasing for similar concepts - clarified the relationship between reference docs and conceptual docs Co-authored-by: Alexander Spies <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
👀URL preview
This should make the reference more digestible via the side nav and therefore more easily navigable:
Screenshots
Nav before
Nav after