Update OSS How-To Xray Tutorial to fix image and caption formatting issues#1438
Update OSS How-To Xray Tutorial to fix image and caption formatting issues#1438ds-hzimmer wants to merge 9 commits intoeclipse-tractusx:mainfrom
Conversation
Fixing some minor issues with image alignment and subtitles/captions not in a new line in Docusaurus rendering that were not visible in editor before publication. Minor rewording in the introduction.
Update minor boldings
Error in markdown linting thus correcting a change with blank lines before captions
Fixed markdown linting error in numbered list
Revised image positions due to persistent issues with images inside ordered lists.
Correction numbered lists and captions as html emphasis
Fix broken link to directly link to the markdown page, as there is no folder "howto-xray" at https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs/oss/howto-xray, only /oss respectively for the rendered page https://eclipse-tractusx.github.io/docs/oss/howto-xray/
stephanbcbauer
left a comment
stephanbcbauer
left a comment
There was a problem hiding this comment.
LGTM thx @ds-hzimmer , please avoid html tags -> we don't need them in Markdown
There was a problem hiding this comment.
Pull request overview
Updates the OSS “Tractus-X Jira Xray Tutorial” documentation to improve Docusaurus rendering consistency—primarily around image/caption alignment and surrounding spacing—while also doing minor wording/formatting refinements.
Changes:
- Reworked the opening section into “Introduction and Prerequisites” and refined wording around Jira/Xray usage and licensing context.
- Standardized screenshot captions (now wrapped in
<p><em>…</em></p>) and adjusted blank lines/<br/>placement to stabilize layout. - Minor formatting tweaks (headings, emphasis, example structure) and updated NOTICE source URL.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…r formatting As identified by Copilot and request by reviewer. <p><em> tags were retained as this otherwise created formatting issues with image captions.
|
@stephanbcbauer Updated pull request to add ALT image text with appropriate descriptions instead of just the name of the image file, incorporated minor fixes as suggested by Copilot AI check, and removed 25 unnecessary line break HTML tags throughout the document replaced with appropriate markdown spacing. I would like to retain the paragraph emphasis image HTML tags for the "Screenshot" image captions, as for unknown reasons otherwise Docusaurus would not render the page as expected with some captions not aligned properly even though they were placed in a new line. This passed in the Markdown linting. |
This is a minor fix for https://eclipse-tractusx.github.io/docs/oss/howto-xray/ to correct formatting issues with some inconsistent alignments for images and their captions/subtitles that were not previously visible in the code editor and only really showed in the Docusaurus rendering of the page.
This was now hopefully corrected with improved leading blank lines, paragraphs and emphasis tags, thus avoiding the need to use an additional Docusaurus image component for inline styles, additional HTML figure tags or other additional CSS files.
Some other minor formattings like bolding of some keywords were also corrected, and the introduction slightly better reworded regarding the free Jira subscription for open source projects.