You are viewing a plain text version of this content. The canonical link for it is here.
Posted to gitbox@hive.apache.org by "zabetak (via GitHub)" <gi...@apache.org> on 2025/07/17 13:41:57 UTC
[PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
zabetak opened a new pull request, #54:
URL: https://github.com/apache/hive-site/pull/54
1. Replace hardcoded tables with toc placeholder
2. Rework some headers content around the toc for better readability
3. Fix a few JIRA links to avoid bad entries in the table of contents
4. Add css rule to hide list elements in the table of contents that are empty (known issue in Hugo)
5. Configure the tableOfContents generation to consider headers from level-1 to level-3
The change aims to reduce boilerplate code, facilitate maintenance, enforce uniform style, and improve page evolution.
The changes were done & verified manually, since crafting an automated script to perform this task was pretty cumbersome given that the content is not uniform.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "zabetak (via GitHub)" <gi...@apache.org>.
zabetak merged PR #54:
URL: https://github.com/apache/hive-site/pull/54
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "Aggarwal-Raghav (via GitHub)" <gi...@apache.org>.
Aggarwal-Raghav commented on PR #54:
URL: https://github.com/apache/hive-site/pull/54#issuecomment-3084958096
Can we extend the changes to `content/community/bylaws.md`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "Aggarwal-Raghav (via GitHub)" <gi...@apache.org>.
Aggarwal-Raghav commented on PR #54:
URL: https://github.com/apache/hive-site/pull/54#issuecomment-3084958585
LGTM +1
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "zabetak (via GitHub)" <gi...@apache.org>.
zabetak commented on PR #54:
URL: https://github.com/apache/hive-site/pull/54#issuecomment-3101449386
Thanks for the reviews @Aggarwal-Raghav and @okumin !
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "okumin (via GitHub)" <gi...@apache.org>.
okumin commented on PR #54:
URL: https://github.com/apache/hive-site/pull/54#issuecomment-3088954405
Thanks. Taking a glance, this is nice. I will locally build it and check some extra pages(e.g., massive nest)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "okumin (via GitHub)" <gi...@apache.org>.
okumin commented on code in PR #54:
URL: https://github.com/apache/hive-site/pull/54#discussion_r2215899439
##########
config.toml:
##########
@@ -60,4 +60,12 @@ theme = 'hive'
iceberg = "https://iceberg.apache.org/docs/latest/hive/"
[outputs]
- home = ["HTML", "RSS", "JSON"]
\ No newline at end of file
+ home = ["HTML", "RSS", "JSON"]
+[markup]
+ [markup.tableOfContents]
+ endLevel = 3
+ ordered = false
+# Ideally we should start from level 2 but various pages
+# contain multiple level-1 headers at the moment that
+# should be displayed in the table of contents
Review Comment:
Thanks for the explanation
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org
Re: [PR] HIVE-29095: Exploit toc shortcode to generate table of contents in doc pages [hive-site]
Posted by "zabetak (via GitHub)" <gi...@apache.org>.
zabetak commented on PR #54:
URL: https://github.com/apache/hive-site/pull/54#issuecomment-3087493440
Thanks for the review @Aggarwal-Raghav . I also applied the change to `bylaws.md`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: gitbox-unsubscribe@hive.apache.org
For additional commands, e-mail: gitbox-help@hive.apache.org