Create workshop kits #57

Closed
econchick opened this Issue Aug 15, 2013 · 9 comments

Projects

None yet

4 participants

@econchick
Owner

Including PDFs like newcoder.io/pdf, how to run/setup the workshop, etc.

@merwok
Collaborator
merwok commented Aug 15, 2013

I’d like to note that Sphinx supports nice PDF exports.

Switching the source format and build toolchain is not trivial, but might not take that long given the size of the material at the moment. I don’t know if rst is harder than markdown for casual contributors; it’s quite well-known in the Python community, can be built automatically by Read The Docs (so avoids the need to commit the produced HTML), and other nice properties.

@treyhunner

👍 PDFs for how to run/setup a workshop would be great.

Some of the organizers of my local Python meetup have discussed the need for a wiki or discussion board/list to exchange ideas and what works/doesn't work with other organizers. Maybe such a community could seed ideas for the initial "how to" PDFs.

Side question: where is the source for those existing PDFs located? I dug through the new-coder repository, but I couldn't find source files to customize the PDFs.

@econchick
Owner

Hey @treyhunner - the PDFs are actually hosted on Google Drive, and just linked to it. The source is here (all generated HTML for the site is located in docs/_site)

@econchick
Owner

And @treyhunner @merwok for the PDFs I generated - I wrote in Markdown, and then used Marked.app on my Mac to literally just print to PDF. It just renders the Markdown in your choice of CSS (I used Upstanding Citizen).

I don't use rST or Sphinx (not yet at least) so that's just been the easiest way. But I link the idea of setting up Sphinx support for this sort of thing.

@treyhunner

Printing markdown to PDF is clever. Is the raw markdown for those PDFs available and open source? If so, we may base our handouts on them for our next workshop.

I think markdown is easier to write but I generally find rST easier to read. If the raw rST is made available it could also act as a good example of how Python documentation is written (in a slightly meta way).

@econchick
Owner

@treyhunner the raw Markdown is literally the whole tutorial plus the setup process (http://newcoder.io/begin/)

All raw Markdown is here - but please bare with me, I'm literally in the middle of reorganizing so it's a bit more readable :)

HTH!

@treyhunner

Great, thanks.

If you ever consider switching to rST I may be able to help with the conversion.

@merwok
Collaborator
merwok commented Aug 15, 2013

Yep, my sneaky suggestion was to convert everything to sphinx, not just part of the material for kits. I can help with Sphinx config and material conversion, and to a small degree with the jinja templates and CSS.

@mathonsunday
Collaborator

Closing this issue and opening a separate one just for the workshop kits that we have not yet created. Feel free to open up a separate issue for rST and/or Sphinx if it's something you are interested in working on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment