Markdown notebook infrastructure.

[tillahoffmann]

This PR extracts some of the infrastructure code from #9. I've added an example document with instructions we can develop into a guide for contributions.

[github-actions]

No broken urls! 🎉
Comment updated at 2024-02-22 with changes from 8e354d6

[github-actions]

No spelling errors! 🎉
Comment updated at 2024-02-22 with changes from 8e354d6

[github-actions]

Re-rendered previews from the latest commit:

• See preview of Bookdown here
• See preview of Coursera/Leanpub version here
• Download the preview of .docx file

Updated at 2024-02-22 with changes from 8e354d6

[howardbaik]

@tillahoffmann I have a very naive question that has to do with virtual environments and committing to GitHub.

If I follow the below workflow:

1. Create a virtual environment within the python folder called .venv
2. Activate the virtual environment and start up Jupyter Lab.
3. Make changes to a .md file and render it to html with make [your markdown document].ipynb.html

Does this mean that the changes I make (while I'm working on a Jupyter Lab server in a virtual environment) can be committed and pushed to this repo? Basically, I'm not sure how to commit and push changes to GitHub when you are working in a virtual environment.

UPDATE: It looks like the requirements.txt file will have all the necessary dependencies so I don't need to worry about not having the right dependencies for future iterations.

[tillahoffmann]

Does this mean that the changes I make (while I'm working on a Jupyter Lab server in a virtual environment) can be committed and pushed to this repo? Basically, I'm not sure how to commit and push changes to GitHub when you are working in a virtual environment.

Yes, you can commit any changes you make from the virtual environment. The virtual environment is independent of any git commands and only affects Python. So you can use git as you usually would.

Regarding your point 3., you can run make [name].ipynb.html if you want to make sure that the notebook executes correctly in the GitHub Action and to inspect the html output. But you don't need to run that step before committing the .md changes to GitHub. All the important content is in the .md, and the .ipynb.html are never added to the git repository. Does that make sense?

[cansavvy]

This is really excellent! Thanks for putting together this infrastructure. I am going to go through the steps to test it!

[cansavvy]

This is great! can't tell you how excited I am to have this set up. We're going to definitely have to use this (with attribution to your work) in future python courses we make with OTTR!

[cansavvy]

This worked beautifully!