You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by "Jyotinder Singh (Jira)" <ji...@apache.org> on 2022/02/22 08:46:00 UTC
[jira] [Updated] (HDDS-6361) Modify docs build flow to replace image tags with shortcodes.
[ https://issues.apache.org/jira/browse/HDDS-6361?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jyotinder Singh updated HDDS-6361:
----------------------------------
Description:
Currently, if we want to add responsive images to the documentation website, we must use a Hugo shortcode introduced in HDDS-6073.
This looks like:
{code:java}
{{< image src="image-name.png">}} {code}
While this shortcode gets converted into an HTML img in the production build after running {{{}hugo -d{}}}, IDE's and GitHub are not able to parse this as an image and make it harder to review pull requests when this format is used.
This Jira introduces a python script that will be called as a part of the maven build process, which will automatically replace all markdown images with their respective shortcodes.
was:
Currently, if we want to add responsive images to the documentation website, we must use a Hugo shortcode introduced in HDDS-6073.
This looks like:
{code:java}
{{< image src="image-name.png">}} {code}
While this gets converted into an HTML img in the production build after running {{{}hugo -d{}}}, IDE's and GitHub are not able to parse this as an image and make it harder to review pull requests when this format is used.
This Jira introduces a python script that will be called as a part of the maven build process, which will automatically replace all markdown images with their respective shortcodes.
> Modify docs build flow to replace image tags with shortcodes.
> -------------------------------------------------------------
>
> Key: HDDS-6361
> URL: https://issues.apache.org/jira/browse/HDDS-6361
> Project: Apache Ozone
> Issue Type: Improvement
> Reporter: Jyotinder Singh
> Assignee: Jyotinder Singh
> Priority: Major
>
> Currently, if we want to add responsive images to the documentation website, we must use a Hugo shortcode introduced in HDDS-6073.
> This looks like:
> {code:java}
> {{< image src="image-name.png">}} {code}
> While this shortcode gets converted into an HTML img in the production build after running {{{}hugo -d{}}}, IDE's and GitHub are not able to parse this as an image and make it harder to review pull requests when this format is used.
> This Jira introduces a python script that will be called as a part of the maven build process, which will automatically replace all markdown images with their respective shortcodes.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org