Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Build basic static HTML framework for displaying course content, #3

Merged
merged 1 commit into from
Mar 13, 2019

Conversation

brson
Copy link
Contributor

@brson brson commented Mar 7, 2019

Fill in with some draft and placeholder content.

I was hoping to have much more content by now, but I need to start landing something.

This is mostly building out a repository structure that supports the various content in the lesson plan, displayed in a consistent way. It does the following:

  • Creates a place for "lessons", in the form of markdown that contains both slide and text material
  • Creates a place for "projects", in the form of markdown project descriptions, and cargo projects containing example solutions and test suites.
  • Makes everything navigable directly on github via markdown -> markdown links
  • Makes everything navigable via a static website that also correctly displays the slides

I've also filled in content for the first part of the first project, after reading through @overvenus's solutions to the MIT course, and the MIT course's descriptions of its own projects.

The structure is similar to @skade's rust-three-days-course.

Rendered pages:

Note that the CSS here is just placeholder.

The vast majority of files here are just js libraries. The interesting stuff is

  • the rendered static site, and navigation between the various content
  • the lessons and projects folders
  • the way every md file is paired with an html symlink to index.html
  • the working slides on the static website
  • the content inside project 1 ("tools"), which is admittedly very incomplete

Fixes tikv/tikv#4164.

Next steps:

  • File bug to improve the CSS. Ask for help.
  • File bug to limit the scope of an MVP - I'm thinking we'll start with the first and last projects, and a complete list of background readings necessary to complete them. Then later come back later and try to add additional lessons.
  • Finish project 1 description
  • File bug to finish code and tests for project 1. Ask for help.
  • File bug to write the final project description. Ask for help.
  • File bug to fill in the readings.

As always, feedback welcome.

cc @overvenus @Connor1996 @nolouch @Hoverbear @siddontang

fill in with some draft and placeholder content.
Copy link
Member

@overvenus overvenus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

overvenus added a commit that referenced this pull request Mar 8, 2019
@siddontang siddontang merged commit 86804d3 into pingcap:master Mar 13, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants