truenas/charts

Minio description field formatted strange

sync-by-unito opened this issue · 4 comments

sync-by-unito commented 
MinIO is a High Performance Object Storage released under Apache License v2.0. It is API compatible with Amazon S3 cloud storage service. Use MinIO to build high 
performance infrastructure for machine learning, analytics and application data workloads.

Seems to be a carriage return between "high" and "performance" when there shouldn't be

Looking at the app_versions.json, this seems to be hard coded in the description string?

https://github.com/truenas/apps/blob/master/trains/stable/minio/app_versions.json

 "readme": "<h1>MinIO</h1>\n<p><a href=\"https://min.io\">MinIO</a> is a High Performance Object Storage released under Apache License v2.0.\nIt is API compatible with Amazon S3 cloud storage service. Use MinIO to build high performance\ninfrastructure for machine learning, analytics and application data workloads.</p>",

If the display field is intelligent enough, it shouldn't be necessary to break paragraphs up?

Session ID: 4e2d1681-c54b-c230-f4b3-d64c1367d0d1

┆Attachments: Screenshot 2024-08-15 at 3.56.21 PM.png | Screenshot 2024-08-15 at 3.57.41 PM.png

sync-by-unito commented

➤ Bug Clerk commented:

Thank you for submitting this TrueNAS Bug Report! So that we can quickly investigate your issue, please attach a Debug file and any other information related to this issue through our secure and private upload service below. Debug files can be generated in the UI by navigating to System > Advanced > Save Debug.

https://ixsystems.atlassian.net/servicedesk/customer/portal/15/group/37/create/153

sync-by-unito commented

➤ Stuart Espey commented:

Note, the description/readme flows just fine… so it appears the fix would be to simply removal unnecessary new lines (/n) in the readme field. I’m not sure if this is a general issue with the other apps or not.

!Screenshot 2024-08-15 at 3.56.21 PM.png|width=75%,alt="Screenshot 2024-08-15 at 3.56.21 PM.png"!

!Screenshot 2024-08-15 at 3.57.41 PM.png|width=781,height=294,alt="Screenshot 2024-08-15 at 3.57.41 PM.png"!

sync-by-unito commented

➤ Stavros Kois commented:

Hello, the string in the json is the content of the README.md for each app.
In which the text is split-ed in multiple lines to ease the reading for the developer.

Both HTML and Markdown should ignore a single line ending when rendering.
But this does not seem to be the case here.

sync-by-unito commented

➤ Stavros Kois commented:

I’ve opened a PR to fix that here truenas/apps_validation#46 ( truenas/apps_validation#46 )