NASA-AMMOS / slim

Software Lifecycle Improvement & Modernization
https://nasa-ammos.github.io/slim/
Apache License 2.0
24 stars 9 forks source link

[Improve Existing Best Practice Guide]: CI Architectural Reference Guide Diagram Clipping Issues #70

Open riverma opened 1 year ago

riverma commented 1 year ago

Checked for duplicates

Yes - I've already checked

Best Practice Guide

Continuous Integration

Best Practice Guide Sections

Reference Architectures

Describe the improvement

The Mermaid diagrams have clipped text that doesn't ready fully. This is present in both GitHub view as well as the rendered RETYPE webpage view. Attached is an example. Additionally the "A series of systems executing builds" diagram is not rendering the bold-typed text properly (picture attached).

Screen Shot 2022-09-15 at 4 25 35 PM Screen Shot 2022-09-15 at 4 26 23 PM
jpl-jengelke commented 1 year ago

What browser are the screenshots from so that I can reproduce this?

Also, I see that in the retype view the bold text is an issue whereas in the GH view it looks proper. I think I need to look into a retype conflict.

jpl-jengelke commented 1 year ago

Changes were made in the develop branch and the issue_23 branch pre-merge to reflow the RA README. We should check with the issue_23 PR to see if this helps it.

riverma commented 1 year ago

@jpl-jengelke - this bug was witnessed in the following environment: Safari 15.5

If you've come up with a potential fix, you may want to try and fork the repository at the branch you've put the fix for (develop?) and try rendering the site in your fork - that way you can test your fix with an independent site URL.

jpl-jengelke commented 1 year ago

I saw part of it on Firefox, also. There appears to be some rendering conflict between retype and quoted labels on Mermaid blocks that have HTML tags. I think I have minimized the Mermaid code, and that may well fix it.

From: Rishi Verma @.> Reply-To: NASA-AMMOS/slim @.> Date: Tuesday, September 27, 2022 at 9:44 AM To: NASA-AMMOS/slim @.> Cc: "Engelke, John M (US 398F-Affiliate)" @.>, Mention @.***> Subject: [EXTERNAL] Re: [NASA-AMMOS/slim] [Improve Existing Best Practice Guide]: CI Architectural Reference Guide Diagram Clipping Issues (Issue #70)

@jpl-jengelkehttps://urldefense.us/v3/__https:/github.com/jpl-jengelke__;!!PvBDto6Hs4WbVuu7!bQ4nSJbOLuLg0SuKMrKkeAxp9rwzAo-UZjMrt9H4IQ-WBrAE8z1wJT4QEuxwwPOGMRMh$ - this bug was witnessed in the following environment: Safari 15.5

If you've come up with a potential fix, you may want to try and fork the repository at the branch you've put the fix for (develop?) and try rendering the site in your fork - that way you can test your fix with an independent site URL.

— Reply to this email directly, view it on GitHubhttps://urldefense.us/v3/__https:/github.com/NASA-AMMOS/slim/issues/70*issuecomment-1259776048__;Iw!!PvBDto6Hs4WbVuu7!bQ4nSJbOLuLg0SuKMrKkeAxp9rwzAo-UZjMrt9H4IQ-WBrAE8z1wJT4QEuxwwP-Z6DzP$, or unsubscribehttps://urldefense.us/v3/__https:/github.com/notifications/unsubscribe-auth/AMPAZADJ75I5PU3X63WKY4TWAMP5DANCNFSM6AAAAAAQN3AYBM__;!!PvBDto6Hs4WbVuu7!bQ4nSJbOLuLg0SuKMrKkeAxp9rwzAo-UZjMrt9H4IQ-WBrAE8z1wJT4QEuxwwLs-rnbI$. You are receiving this because you were mentioned.Message ID: @.***>

jpl-jengelke commented 1 year ago

I believe I have this resolved pending PR release.

riverma commented 1 year ago

@jpl-jengelke - still see the clipping issues in the develop branch. Did you push the fix to another?

riverma commented 1 year ago

@jpl-jengelke - clipping issues remain on deployed branch. See example: https://nasa-ammos.github.io/slim/continuous-integration/reference-architectures/

We've got about 12 people who indicated interest in using this guide. Let's fix these so that we can help them infuse! :) Once fixed, we can work on https://github.com/NASA-AMMOS/slim/issues/77