Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

templates for this workshop #3

Open
tracykteal opened this issue Nov 24, 2017 · 4 comments
Open

templates for this workshop #3

tracykteal opened this issue Nov 24, 2017 · 4 comments

Comments

@tracykteal
Copy link
Contributor

Rather than having lessons in Markdown it would make sense to have the lessons in Jupyter notebooks. What are some ideas on how to do this.

@tracykteal
Copy link
Contributor Author

From Ryan Lovett:

For Data 8 at UC Berkeley, a collection of notebooks is converted into an online gitbook textbook. Students can launch the notebooks from the gitbook onto a JupyterHub or BinderHub.

@tracykteal
Copy link
Contributor Author

Rather than doing something like this, for now we can just link to Jupyter notebooks from the index page.

We still need a general format for that template though that would have sections for learning objectives and content, like in the Markdown template, e.g.
http://www.datacarpentry.org/spreadsheet-ecology-lesson/01-format-data/

Likely this is just having a header section that has a place to put title and learning objectives. There might also be a way to have special Markdown for Exercises or Discussion sections, but note sure if that would be possible.

@dsoto
Copy link

dsoto commented Jan 8, 2018

The other SC lessons I've seen use some processing to create the formatting for different callout sections. I think we could do something similar with the cell and notebook metadata in conjunction with the nbconvert processors. Before implementing anything, we'll want to think about the costs and benefits of creating and maintaining another pipeline for the lessons.

@tracykteal
Copy link
Contributor Author

We're likely going to be updating SWC/DC templates, and having a notebook template as a pilot and starting place could be a good idea. If we can do the callouts without too much work, it would be great to see what that would look like at least. Also, the template could be useful for anyone developing lessons with the Jupyter notebook.

But, yes, we don't want a whole bunch of different versions of the infrastructure, so we'll want to make the decisions on this with regard to how much work it would be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants