eoas-ubc / eoas_tlef

developing jupyter courseware for eoas 2020

BSD 3-Clause "New" or "Revised" License

4 stars 6 forks source link

getting started #1

Open phaustin opened 4 years ago

phaustin commented 4 years ago

document how to get started

[ ] write workflow overview
- tools to support our workflow (jupytext, liveserver, watchdog, etc.) https://github.com/eoas-ubc/jb_tools
[ ] write jupytext intro
[ ] write git intro for faculty
- (tracking the github intro on #30 )
[ ] write markdown editing intro
[ ] write docx pandoc intro
[ ] write pptx to notebook intro
[ ] record some 15 second camtasia screencasts

phaustin commented 4 years ago

Here's the raw markdown:

# document how to get started
- [ ] write [workflow overview](https://github.com/eoas-ubc/eoas_tlef/blob/master/docs/getting_started.md)
- [ ] write [jupytext intro](https://github.com/eoas-ubc/eoas_tlef/blob/master/docs/learning_jupytext.md)
- [ ] write [git intro](https://github.com/eoas-ubc/eoas_tlef/blob/master/docs/learning_git.md) for faculty
- [ ] write [markdown editing](https://github.com/eoas-ubc/eoas_tlef/blob/master/docs/learning_markdown.md) intro
- [ ] write docx pandoc intro
- [ ] write pptx to notebook intro
- [ ] record some 15 second camtasia screencasts

fhmjones commented 4 years ago

Existing docs ( .md files in the doc folder) were updated May 26th.
Documentation could either evolve as the project progresses or we can circle back to make concise documentation based on decisions and procedures that have been confirmed.
The update today is sort of a hybrid. I was trying to keep notes over the last few weeks but they were getting changed so often I decided it would be more efficient to write docs intermittently when we actually know something.
Some docs will boil down to adaptations of documentation that already exists "out there".