[
https://issues.apache.org/jira/browse/FLINK-23804?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18137093#comment-18137093
]
Ramin Gharib commented on FLINK-23804:
--------------------------------------
Picking this up. The approach was discussed on the dev list:
https://lists.apache.org/thread/3w04cd3w162k7hvko52of7vrvmjm4cjs
Plan:
* First, add the new structure: one page per function with a fixed set of
sections, generated from YAML, a sidebar that groups the function pages by
category, and an A-Z overview at the current URL.
* Then convert the functions category by category, recheck each function
against its implementation and add missing examples.
* Separately, publish each function page as Markdown and add an llms.txt index.
Each step has a sub-task. Category sub-tasks will be added as the conversion
starts.
> Restructure documentation of built-in functions
> -----------------------------------------------
>
> Key: FLINK-23804
> URL: https://issues.apache.org/jira/browse/FLINK-23804
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, Table SQL / API
> Reporter: Ingo Bürk
> Assignee: Ramin Gharib
> Priority: Minor
>
> The current documentation for built-in functions does not scale well. Tables,
> even in sections, become very hard to read with many entries, and there is
> very little space for proper signatures, details, or examples.
> We should restructure this page such that functions are not grouped into
> tables but rather their own sections. This could possibly involve splitting
> the page into several pages (per category).
> In the end, we should have a documentation that lists signatures properly,
> including return types, multiple signatures, signatures for both Table API
> and SQL, allows for detailed descriptions of each function and various
> examples in both APIs.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
