DO NOT commit personal configuration files to git!
This directory contains:
config.example.yaml- Template (safe to commit)config.yaml- Your personal config (gitignored)- Any
*.yamlfiles - User configs (gitignored except example)
-
Never share your personal config files - they may contain:
- Google Drive file IDs (private links)
- YouTube video IDs (potentially private)
- Personal course information
- File paths and names
-
Use the example template:
cp config.example.yaml config.yaml # Edit config.yaml with your details -
Check before committing:
git status # Verify no personal configs are staged -
All user configs are gitignored by default:
config/*.yaml(exceptconfig.example.yaml)config/*_maciek.yamlconfig/*_personal.yamlconfig/*_private.yaml
# Copy the template
cp config.example.yaml config.yaml
# Or create a personal named config
cp config.example.yaml config/my_course.yaml
# Edit with your details
nano config.yamlIf you want to share a configuration example:
- Remove all real file IDs
- Replace with placeholders like
"YOUR_FILE_ID_HERE" - Remove personal information (names, paths, etc.)
- Save as a new example file in
examples/directory
Remember: Once data is pushed to GitHub, it's difficult to completely remove. Always verify before pushing!