Jyotinder Singh created HDDS-6361:
-------------------------------------

             Summary: 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


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.



--
This message was sent by Atlassian Jira
(v8.20.1#820001)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to