search

DesignSafe-CI / DS-User-Guide

User Guide for DesignSafe
https://www.designsafe-ci.org/user-guide/
0 stars 8 forks source link

Adding changes to Pedro Arduino use case #47

Closed parduino closed 3 months ago

parduino commented 3 months ago

Overview

…

Related

Changes

…

Testing

1.

UI

…

parduino commented 3 months ago

Adding changes to Pedro Arduino use case

parduino commented 3 months ago

Please let me know if this creates problems. I only changes Arduino files.

silviamazzoni commented 3 months ago

@parduino these are just editorial changes, correct? They look good to me. It does look like you did work with the latest version of the docs, so it looks great to me. Anything I should look at specifically? otherwise I'll approve it.

parduino commented 3 months ago

Hi Silvia,

Yes, mostly editorial changes and cleaning stuff. Basic Markdown is very limited, so it has to be complemented with functionality either from HTML or CSS. Unfortunately, the system used at DesignSafe does not allow much of this functionality. So, I have been trying to use as much plain markdown as possible.

I will be testing all the notebooks next. They all point to /community in DesignSafe and should work, but Tapis apps constantly change (particularly in name) and python dependencies too. So, I will take a look at that too.

So, It is very possible I will have another pull request…

Pedro

From: Silvia Mazzoni @.> Sent: Tuesday, June 18, 2024 11:19 AM To: DesignSafe-CI/DS-User-Guide @.> Cc: Pedro Arduino @.>; Mention @.> Subject: Re: [DesignSafe-CI/DS-User-Guide] Adding changes to Pedro Arduino use case (PR #47)

@parduinohttps://urldefense.com/v3/__https:/github.com/parduino__;!!K-Hz7m0Vt54!lFynRz0c0sl609__8YbIYPW-oSo1rittur_PlhE7dKZNBxFAGUIpeyLZ6BZHQpSvr3NOIxXRsHqNlFPXymPAVNA$ these are just editorial changes, correct? They look good to me. It does look like you did work with the latest version of the docs, so it looks great to me. Anything I should look at specifically? otherwise I'll approve it.

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/DesignSafe-CI/DS-User-Guide/pull/47*issuecomment-2176700343__;Iw!!K-Hz7m0Vt54!lFynRz0c0sl609__8YbIYPW-oSo1rittur_PlhE7dKZNBxFAGUIpeyLZ6BZHQpSvr3NOIxXRsHqNlFPXK_Jl1no$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/AGFDCJOU5HXSX7H7YQHFNT3ZIB22NAVCNFSM6AAAAABJQQLAMKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZWG4YDAMZUGM__;!!K-Hz7m0Vt54!lFynRz0c0sl609__8YbIYPW-oSo1rittur_PlhE7dKZNBxFAGUIpeyLZ6BZHQpSvr3NOIxXRsHqNlFPXF3CQMsQ$. You are receiving this because you were mentioned.Message ID: @.**@.>>

silviamazzoni commented 3 months ago

@wesleyboar i'm happy to have this update merged. @parduino yes MD is limited, but Wesley and I have been working on adding functionality. In working with Wesley, I learned that, afterall, md is just a shortcut to html, a way to simplify the text and keep a uniform style. so we should minimize raw html and css code. Wes can create "any" md cod you'd like. so he and I will have a look at your edits and see what Wesley can do to make it a useable style. we need consistency across all use-case documentation. thank you for this.

silviamazzoni commented 3 months ago

@parduino i see you reduced the figure sizes.... i'm afraid this may lose resolution. Was the reduction due to display issues? @wesleyboar can you do your magic on that? so that we don't have to reduce image quality?

parduino commented 3 months ago

Hi Silvia,

Yes, one of the problems using plain markdown is that you can’t control sizes/scaling/centering of figures and tables.

This is why I usually used HTML commands in markdown files. It works beautifully on my end but has to work on the end where these things are posted.

So, yes, I changed the size of all figures trying to fit sizes I think can be used here. But, this is on my monitor…

I wonder how all this looks on your end.

If possible I would recommend to add functionality for:

a) Centering and scaling of figures and tables

b) Basic equations functionality

If it does not look good, please don’t accept the pull request yet. I can make changes to make this look well.

Thanks!!

PEdro

From: Silvia Mazzoni @.> Sent: Tuesday, June 18, 2024 11:49 AM To: DesignSafe-CI/DS-User-Guide @.> Cc: Pedro Arduino @.>; Mention @.> Subject: Re: [DesignSafe-CI/DS-User-Guide] Adding changes to Pedro Arduino use case (PR #47)

@parduinohttps://urldefense.com/v3/__https:/github.com/parduino__;!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8Id1pc1RA$ i see you reduced the figure sizes.... i'm afraid this may lose resolution. Was the reduction due to display issues? @wesleyboarhttps://urldefense.com/v3/__https:/github.com/wesleyboar__;!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8I9gThBrk$ can you do your magic on that? so that we don't have to reduce image quality?

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/DesignSafe-CI/DS-User-Guide/pull/47*issuecomment-2176745805__;Iw!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8Ip6OCfU8$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/AGFDCJJK3ELFZO2SS573EUDZIB6IHAVCNFSM6AAAAABJQQLAMKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZWG42DKOBQGU__;!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8I4k7ZSAw$. You are receiving this because you were mentioned.Message ID: @.**@.>>

parduino commented 3 months ago

Hi Silvia,

Wait, don’t accept the pull request. I see the images loose quality when I try to resize them to fit markdown… Working on this. Thanks

PEdro

From: Silvia Mazzoni @.> Sent: Tuesday, June 18, 2024 11:49 AM To: DesignSafe-CI/DS-User-Guide @.> Cc: Pedro Arduino @.>; Mention @.> Subject: Re: [DesignSafe-CI/DS-User-Guide] Adding changes to Pedro Arduino use case (PR #47)

@parduinohttps://urldefense.com/v3/__https:/github.com/parduino__;!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8Id1pc1RA$ i see you reduced the figure sizes.... i'm afraid this may lose resolution. Was the reduction due to display issues? @wesleyboarhttps://urldefense.com/v3/__https:/github.com/wesleyboar__;!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8I9gThBrk$ can you do your magic on that? so that we don't have to reduce image quality?

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/DesignSafe-CI/DS-User-Guide/pull/47*issuecomment-2176745805__;Iw!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8Ip6OCfU8$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/AGFDCJJK3ELFZO2SS573EUDZIB6IHAVCNFSM6AAAAABJQQLAMKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZWG42DKOBQGU__;!!K-Hz7m0Vt54!m7Oja05gj1YZsTUMtMQ6GLX8Lfu2QV-422kfQPUD8OqRwz1y4iWwxIbw_t_QLYzHEnXn0qH0EheT_I8I4k7ZSAw$. You are receiving this because you were mentioned.Message ID: @.**@.>>

parduino commented 3 months ago

Hi Wesley and Silvia,

How does it look right now?? I made further changes and brought back images with the original size

silviamazzoni commented 3 months ago

I'll leave it to @wesleyboar at this point, he has the setup to see how it looks.

wesleyboar commented 3 months ago

Okay. Here's a preview of the changes as of a744abd: https://pprd.docs.tacc.utexas.edu/usecases/arduino/usecase_quoFEM/ Disregard the domain. It's the only server to which I can ad-hoc deploy docs.

I am unavailable to eagle-eye review until Monday.

I still suggest the change I proposed at https://github.com/DesignSafe-CI/DS-User-Guide/pull/47#discussion_r1644955322.

wesleyboar commented 3 months ago

P.S. Everyone can have "the setup". There are instructions for testing locally.

wesleyboar commented 3 months ago

Merging based on my own approval and https://github.com/DesignSafe-CI/DS-User-Guide/pull/47#issuecomment-2177323389.