CodeYourFuture / curriculum

The CYF Curriculum
https://curriculum.codeyourfuture.io
Other
34 stars 41 forks source link

Retro block uses link to Google timer not a timer shortcode #847

Open illicitonion opened 3 months ago

illicitonion commented 3 months ago

e.g. in https://curriculum.codeyourfuture.io/js1/sprints/1/day-plan/#retro in the "Text" tab

Tim-Quattrochi commented 3 months ago

Hi, can I take on this issue?

illicitonion commented 3 months ago

Hi @Tim-Quattrochi! That would be great if you would be interested! I think the content you'd want to edit is in https://github.com/CodeYourFuture/curriculum/blob/main/common-content/en/blocks/retro/index.md and you can see an example of the timer shortcode in https://github.com/CodeYourFuture/curriculum/pull/846/files#diff-4a82407713fcc1fa17da022bc461ffe66932e864dc7176b4c78ee7fe98334f29

Thanks!

Tim-Quattrochi commented 3 months ago

Hi @Tim-Quattrochi! That would be great if you would be interested! I think the content you'd want to edit is in https://github.com/CodeYourFuture/curriculum/blob/main/common-content/en/blocks/retro/index.md and you can see an example of the timer shortcode in https://github.com/CodeYourFuture/curriculum/pull/846/files#diff-4a82407713fcc1fa17da022bc461ffe66932e864dc7176b4c78ee7fe98334f29

Thanks!

@illicitonion

Edited to add link to WIP commit on my branch:

Here is my progress so far. I am able to implement the timer shortcode into the retro > index.md, however, I am having issues with nesting the timer in the <note> shortcode. When I do, it simply renders the partial. I am going to look more at the documentation but if you have any pointers that would be awesome, thank you.

Screenshot 2024-08-05 at 1 48 50 AM

Without Nesting

Screenshot 2024-08-05 at 1 41 30 AM

SallyMcGrath commented 3 months ago

👀 That looks to me like a Hugo markdown bug. It's getting confused and parsing the html as markdown commands

Like a blockquote

I will take a look and see if there's something easy we can do to jump this out of the render loop

SallyMcGrath commented 2 months ago

Update on this: it's specifically in tabs and it's caused by this line https://github.com/CodeYourFuture/curriculum/blob/e8be388b340d5540e51719f3ef48173ece5d0ad4/common-theme/layouts/shortcodes/tabs.html#L27

The render string is rendering the timer (it thinks the > is a blockquote) before Hugo can take care of it.

Tabs are always such a pain!

Tim-Quattrochi commented 2 months ago

Update on this: it's specifically in tabs and it's caused by this line

https://github.com/CodeYourFuture/curriculum/blob/e8be388b340d5540e51719f3ef48173ece5d0ad4/common-theme/layouts/shortcodes/tabs.html#L27

The render string is rendering the timer (it thinks the > is a blockquote) before Hugo can take care of it.

Tabs are always such a pain!

Nice research. How did you want to take care of this? Is this something where the tabs shortcode needs to be modified or am I rendering wrong?

SallyMcGrath commented 2 months ago

Oh you've done nowt wrong. The opposite! You've found a genuine bug. I think it will need the tab partial to be rewritten so they don't render. Reading the file it looks like the tabs were from Docsy and really I should have just written them myself. But I haven't got time to do that now as we're launching all these courses.

So I think just leave it - maybe let's write up this bug and the need for tabs to be rewritten so they pass through and do not render and someone, realistically me but hey I live in hope, will pick it up for a nice long plane ride activity or something.