There are two main options to view project files:
- [Easiest] Use the published online view
- [Most Complete] Download Obsidian, then clone and open this repository
If you'd like to help improve this content, feel free to dive in anywhere! The GitHub is publicly visible at https://github.com/johnjackoleary/cfi-commonplace-book
If you want a starting point, any notes tagged with #todo are good candidates for some love. Check out [[Todo]] for a complete list.
And thank you!
You can submit issues on GitHub, and they'll show up similar to this example.
Suggestions can be big or small, any observations or input are helpful!
- Install GitHub Desktop
- Clone the repository wherever GitHub desktop suggests
- Open the top level folder with Obsidian
- Click on the file you'd like to edit in GitHub, and click the edit (pencil) button.
- Next, 'propose' your changes. Feel free to change the message and description to explain the change and update the branch name. Or don't change anything, that's also fine :)
- Finally, open a 'pull request' to show that the changes are ready to be reviewed and merged. You can see an example of this here.
There's a few branch protections in place and specific merge strategies. Generally, you should be good to go however you prefer to approach it.
- Files starting with "~ " are meant to show up on top of the list, likely they are MOCs or overviews.
- Files starting with "+ " are aggregator files, which have no custom content but pull information about the files using Dataview or the template in [[Update Publish Files]].
- Directories:
- Filed: Published information. Should be clean enough to be useful, with todo tags indicated in any areas yet to tackle.
- Lesson Plans: Ways of teaching key concepts. Should pull mostly from cards in Filed.
- Media: Small images to help build out important filed information.
- Resources are intended to be content you may wish to pull up during the lesson itself
- Resources intended at prep work or homework should be in a pre-lesson file (such as [[~ PPL Pre-Lesson Reading]])
- References is an outdated approach and are slowly being cleaned up. References should be included in-line or should be a resource.
- Tags
- with multiple words should use a hyphen ('my-awesome-tag')
- Obsidian supports nested tags ('my/awesome-tag'), and they are used periodically to help keep groupings clear
- #todo:: standardize when to use which headings levels, maybe. Or just live with it? Variety is the spice of life...
- Blocks of Learning Sizes #todo :: Helpful info, seems not worth having on top readme though
- 400px x 400px for cards
- somethingx440px for labels
- 80px between rows
- 160 between columns
- 20 between side edge of groups, 40 between top edge of groups
All plugins are meant to be optional, although Dataview is heavily used.
- Dataview is used heavily for aggregating files and reformatting raw data. Most unusual symbols in the Markdown, especially in files like Gait Charts (e.g. [[C152 Gait]]), are for Dataview.
- #todo :: This is difficult for publishing, because Dataview doesn't work with publish. May need to pivot further away from Dataview, for now the publishing process includes generating some Dataview tables from queries in [[Update Publish Files]].
- Advanced Tables is for convenience in editing tables. This is totally optional but very helpful.
- Text Format convenience for formatting with keyboard shortcuts.
- Templater for Obsidian Publish to work with Dataview (see article here)
| Contributor | Blurb | URL |
|---|---|---|
| Edward Abraham | Bay Area native and flight instructor with emphasis on ADM and SRM | |
| Jack O'Leary | Bay Area flight instructor with a passion for learning | cfijack.com |
| Peter Monaco | Bay Area native and flight instructor | cfipete.com, LinkedIn |
CFI Commonplace Book is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Important
In particular, note these excepts from Section 5 – Disclaimer of Warranties and Limitation of Liability.
- ...the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation... fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable....
- To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages....