[
https://issues.apache.org/jira/browse/HIVE-29095?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
ASF GitHub Bot updated HIVE-29095:
----------------------------------
Labels: pull-request-available (was: )
> Site: Exploit toc shortcode to generate table of contents in doc pages
> ----------------------------------------------------------------------
>
> Key: HIVE-29095
> URL: https://issues.apache.org/jira/browse/HIVE-29095
> Project: Hive
> Issue Type: Task
> Components: Website
> Reporter: Stamatis Zampetakis
> Assignee: Stamatis Zampetakis
> Priority: Major
> Labels: pull-request-available
>
> The majority of [documentation pages|https://hive.apache.org/docs/latest/] in
> the Website contain a table of contents section that is hardcoded inside the
> markdown file. Consider for instance the [DDL
> manual|https://github.com/apache/hive-site/blob/514c15f8248a02e4a383fa249b4078c876684d5a/content/docs/latest/languagemanual-ddl_27362034.md#L10].
> Every time someone updates a page the table of contents needs to be manually
> modified to be kept in sync.
> The Hugo framework that we are using in the Website provides a [feature to
> automatically generated a table of
> contents|https://gohugo.io/methods/page/tableofcontents/] based on the
> Markdown headers in each page.
> The goal of this task is to replace all hardcoded tables with the {{<toc>}}
> shortcode placeholder to generate automatically the contents table. This has
> various advantages:
> * Less boilerplate code in Markdown pages
> * Uniform generation/representation across pages
> * Less maintenance overhead
> * Easier evolution
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
