[
https://issues.apache.org/jira/browse/FLINK-41315?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ramin Gharib closed FLINK-41315.
--------------------------------
Fix Version/s: 2.5.0
Resolution: Fixed
Fixed in master: 61e584e530950b5eb31189320c8e6ef7c50f93bc
> Add the page structure for built-in function docs
> -------------------------------------------------
>
> Key: FLINK-41315
> URL: https://issues.apache.org/jira/browse/FLINK-41315
> Project: Flink
> Issue Type: Sub-task
> Components: Documentation
> Reporter: Ramin Gharib
> Assignee: Ramin Gharib
> Priority: Major
> Labels: pull-request-available
> Fix For: 2.5.0
>
>
> Add the structure that the per-category conversions build on. Discussed on
> the dev list: https://lists.apache.org/thread/3w04cd3w162k7hvko52of7vrvmjm4cjs
> Scope:
> * Function data in YAML with one field per section: syntax, arguments,
> returns, usage notes, examples and see also.
> * One template that renders every function page with these sections, for the
> English and the Chinese docs.
> * Syntax tabs for SQL and the Table API in Java and Python. Scala is left out
> because the Scala APIs are deprecated.
> * The sidebar lists the categories under Built-in Functions, and each
> category folds open to its function pages.
> * The existing Built-in Functions page becomes an A-Z index of all functions
> and operators. It keeps its URL and aliases.
> * Categories that are not converted yet keep their current table on their
> category page.
> * REGEXP_EXTRACT is converted as the first function to validate the template.
> Out of scope: converting the other functions, which gets one sub-task per
> category, and the Markdown output with llms.txt, which has its own sub-task.
> Open question: generate the pages with Hugo content adapters, which need Hugo
> 0.126 or later while the docs pin 0.124.1, or with a script.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
