ClojureBridge/curriculum

Update slides to match current state of curriculum

Closed this issue · 9 comments

bridgethillyer commented

This is going to be tricky. We need a plan for how to keep these up to date.

bridgethillyer commented

Take date and location out of slides

davidchambers commented

Take date and location out of slides

Do you mean these lines? I assumed them to be placeholders to be replaced with the appropriate data when this repository is forked for a specific event.

bridgethillyer commented

The curriculum is going to have some level of update before the end of summer 2014, so the slides should be updated after that happens.

bridgethillyer commented

@davidchambers do you feel like the slides are in good shape based on SF? Or do they need to be updated? If so, and you remember anything, can you add some notes to this issue? Thanks!

k4y3ff commented

This issue references updating the slides, but have we discussed how we want to keep the slides up to date, long-term? A section in CONTRIBUTING.md is necessary at this point, IMHO.

yokolet commented

Hi all,
I made a progress today. See, http://localhost:5555/experimenting-curriculum-ghpages/intro.html, I need to add css/javascript to make long sentences pop up, though.

The page's source is https://github.com/yokolet/experimenting-curriculum-ghpages/blob/gh-pages/intro.md

This markdown has some styling notations, but basically normal markdown. So people can make a pull request to the markdown file. Once the pull request is merged, updated slides will be there.

I'll keep working on this some more.

yokolet commented

Now, my experimenting comes here.

This markdown file,
https://github.com/yokolet/experimenting-curriculum-ghpages/blob/gh-pages/intro.md
is rendered,
http://yokolet.github.io/experimenting-curriculum-ghpages/intro.html

I added some styling markdown notations and html tags in the file to make it slide-ish. Long sentences are hidden and show up when the button is clicked. But, still, the markdown file is readable as markdown on github.

I think we should move all curriculum contents to gh-pages branch and keep markdown files up to date. Then, a sync problem between outlines and slides will go away. Just pushing changes or merging pull requests update the slide on github pages. Besides, editing markdown is much easier than html.

If you think this is the right way, I'll move my work on curriculum repository an change other curriculum markdown files. How do you think?

yokolet commented

Over the weekend, I moved all contents to gh-pages and add styling things to curriculum markdown files. Now we can see the slides at http://clojurebridge.github.io/curriculum/ , which are rendered from markdown files in outline directory.

Also I added titles to each slides if missing. It was not apparent but on slides, no title pages looked weird. If those titles are not appropriate, open an issue or make a pull request.

Plus, I added some samples and words where didn't make sense. I guess some were deleted but explanations remained unedited.

As an editing guide, I added https://github.com/ClojureBridge/curriculum/blob/gh-pages/EDITING-CURRICULUM.md . So, have a look before editing or merging PR.

Now, curriculum markdown files are the source of slides and a sync problem's gone. I'm going to close this issue.