bootstrapworld / curriculum

6 stars 6 forks source link

Generate other google files from asciidocs #2064

Closed flannery-denny closed 2 months ago

flannery-denny commented 4 months ago

This year we successfully asciidocified slide generation. Is it perhaps the first frontier of many?

What makes me ask is that

And by keeping these files outside of our repository they are much harder to maintain.

schanzer commented 4 months ago

LOVE this idea, @flannery-denny!

I've tweaked the title and added checkboxes, because this really is a lovely idea. Here's what's standing in our way:

  1. The slide deck is obviously lower-hanging fruit, but it's not easy. Our solution to md2googledoc's terrible table conversion was to create our own pipeline that converts all tables as images, then makes slides with those images. This won't work at all for the research paper, so we'll either need to do the paper in raw markdown or have Dorai create bypass mechanism that lets certain tables pass through to asciidoc.
  2. There's a project called pandoc, which converts asciidoc to ODT (which can be manually imported into gdocs). It's a rather large dependency and can't be easily installed via npm, so I'm hesitant to add it. Moreover, Google Docs secretly supports native markdown, so I'm tempted to say we just make a raw markdown file for the research paper and put that in our repo. Definitely something to think about once summer is up and running.
schanzer commented 2 months ago

@flannery-denny I've been thinking about this today, and the tech lift required to do this is enormous. Given that these are only a few documents - and that our goal is to stabilize them to the point where they don't change much - this is likely an unachievable goal. I'd like to at least label this as "not urgent", if not close. What do you think?