Classnotes Templates for Easier Post-Event Material Generation

[jordanmccullough]

The current process for generating event/training classnotes is tedious. It also includes copy-pasting of resources. This workflow needs to 💀.

This undertaking separates the teacher information (name, GitHub link, Twitter handle), resources, and CLI to maintain a DRY approach to the content and allow simpler maintainence of resources across all post-event classnote documents.

The new classnotes markdown will now focus on the page's content by means of the YAML, and the content body being the only custom field for CLI.

 --- layout: classnote title: Template Class Notes Title description: Sample description of event eventdate: 2013-12-12 tags: [notes] teacher: - teachers/jordanmccullough --- 

[jordanmccullough]

Alright @github/training-team this is ready for your 👀.

One thing for to verify as you review/edit this PR pertains to the content for the includes/materials/advanced. Right now its just "TBD". Help populating this file with Advanced course materials would be ✨. See the includes/materials/foundations for reference.

[jordanmccullough]

Just as visual reference. The layout and content has not changed, just the way we're generating the classnote artifact.

[parkr]

Why not call this teachers? You'll likely want to keep it consistent (i.e. always an Array), so the pluralized key might make more sense (esp. for open-source contributions :)

[parkr]

This is awesome! 👍 Great use of includes, too.

[matthewmccullough]

The fact that @parkr just commented on something in training.github.com makes me unreasonably happy.

[jordanmccullough]

@parkr You are so correct. Nice call! See d9c3c26

[brntbeer]

training.github.com/presentations?

[matthewmccullough]

@jordanmccullough let me know if there's anything later tomorrow I can do to help this ship.

[jordanmccullough]

I'm implementing MomentJS for some easier date rendering. As soon as that's in, this should be 🚢able.

[jordanmccullough]

Historically, the event date was included in the main content to indicate when the training event occurred. Using MomentJS a nicely formatted string can be injected in based on the YAML date field.

[parkr]

@jordanmccullough Why not use liquid directly, rather than Moment.js?

{{page.date | date:"%B %d %Y" }}

[jordanmccullough]

@parkr A compelling argument for sure. Honestly, because I didn't think about exploiting Liquid's support for this. Fewer JS scripts for the win. Thanks for pointing this out!

[tlberglund]

@jordanmccullough If I understand correctly, creating new classnotes will now require only that I make a duplicate of sample.md, right? I would ❤️ that a lot.

[parkr]

require only that I make a duplicate of sample.md

@tlberglund./script/new-classnote TITLE [opts] might be a great idea :)

[tlberglund]

@parkr We have an internal script a lot like that! It could conceivably migrate to this repo.

[jordanmccullough]

@tlberglund That is correct! The only custom content is the CLI in the .md file.

Round II will include additional course: definitions, but for now it's exclusively the Foundations one.

Let's 🚢 this!

[brntbeer]

Works for me. tested it with a template as well

[matthewmccullough]

@jordanmccullough I love this. 👍

[brntbeer]

yolo