JyotinderSingh opened a new pull request #3122: URL: https://github.com/apache/ozone/pull/3122
## What changes were proposed in this pull request? Currently, if we want to add responsive images to the documentation website, we must use a Hugo shortcode introduced in [HDDS-6073](https://issues.apache.org/jira/browse/HDDS-6073) (#2898). This looks like: ``` {{< image src="image-name.png">}} ``` While this shortcode gets converted into an HTML `img` in the production build after running `hugo -d`, IDEs 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 - allowing developers to use familiar native markdown syntax (readable by GitHub and IDEs). ## What is the link to the Apache JIRA https://issues.apache.org/jira/browse/HDDS-6361 ## How was this patch tested? Ran `mvn clean install`. `hadoop-hdds/docs/target/classes/docs/*` HTML files contain images with the correct `img` tags: ``` <img src='PrefixFSO-Rename.png' alt='Prefix FSO Rename' class="img-responsive"/> ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
