Skip to content

[DOCS v3] Break out ESQL functions into subpages #126199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
5 of 16 tasks
leemthompo opened this issue Apr 3, 2025 · 2 comments · Fixed by #126279
Closed
5 of 16 tasks

[DOCS v3] Break out ESQL functions into subpages #126199

leemthompo opened this issue Apr 3, 2025 · 2 comments · Fixed by #126279
Assignees
Labels
:Analytics/ES|QL AKA ESQL >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team

Comments

@leemthompo
Copy link
Contributor

leemthompo commented Apr 3, 2025

Now that we are free from the old asciidoc constraints we can break this giant page out into digestible sub-pages. I've outlined what needs to be done, some perhaps can be done manually by writers, but other updates might need to be handled via the generated code.

Here's what I think needs to be done:

1

  • Remove original includes in monolith page

2

  • Create new files for dedicated function pages in a new functions-operators directory
    • New subpage files:
      • Create a new file in the functions-operators directory
      • Add an include statement that references the snippet file
      • In the snippet file (being included):
        • Identify the existing heading and its custom anchor
        • Remove this heading from the snippet file to avoid duplication
      • Add the heading extracted from the snippet file, preserving its custom anchor, to the new subpage file
        • Convert this heading to an H1

3

  • Update the TOC file
    • Update the toc.yml to include the new files as children of the main functions-operators page
diff --git a/docs/reference/query-languages/toc.yml b/docs/reference/query-languages/toc.yml
index deadd649b91..069468133f9 100644
--- a/docs/reference/query-languages/toc.yml
+++ b/docs/reference/query-languages/toc.yml
@@ -87,6 +87,19 @@ toc:
       - file: esql/esql-syntax.md
       - file: esql/esql-commands.md
       - file: esql/esql-functions-operators.md
+        children:
+          - file: esql/functions-operators/aggregation-functions.md
+          - file: esql/functions-operators/grouping-functions.md
+          - file: esql/functions-operators/conditional-functions-and-expressions.md
+          - file: esql/functions-operators/date-time-functions.md
+          - file: esql/functions-operators/ip-functions.md
+          - file: esql/functions-operators/math-functions.md
+          - file: esql/functions-operators/search-functions.md
+          - file: esql/functions-operators/spatial-functions.md
+          - file: esql/functions-operators/string-functions.md
+          - file: esql/functions-operators/type-conversion-functions.md
+          - file: esql/functions-operators/mv-functions.md
+          - file: esql/functions-operators/operators.md
       - file: esql/esql-metadata-fields.md
       - file: esql/esql-multivalued-fields.md
       - file: esql/esql-process-data-with-dissect-grok.md

4

  • Fix references in lists files
    • Update all references in list files to point to the correct subpages instead of the original monolithic file

5

  • Fix other function references
    • Update references in function descriptions and parameter files to point to the appropriate new function-specific files
@leemthompo leemthompo added :Analytics/ES|QL AKA ESQL >docs General docs changes Team:Docs Meta label for docs team labels Apr 3, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/ES|QL AKA ESQL >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team
Projects
None yet
3 participants