Welcome to CS Unplugged¶
Welcome to the documentation for the CS Unplugged project. The documentation is split into the following sections:
Getting Started Documentation¶
This documentation contains:
Our expectations of your contributions to the project
Steps to install the project on your system
Explainations on how the project is setup
Details on basic commands to use the system
Developer Documentation¶
This documentation is for those who want to contribute to developing the Django system for delivering the CS Unplugged content. This is the documentation to read if you want to do any of the following (or similar):
Edit HTML templates used to render webpages
Edit CSS used for styling the website
Add a generatable PDF resource
Contribute to test suite for checking database models
Alter URL routing for views
Table of Contents
- Getting Started
- Contributing Guide
- Installation Guide
- Requirements
- Recommended Reading
- Step 1: Setup Virtual Machine (optional)
- Step 2: Install Git
- Step 3: Create GitHub Account
- Step 4: Set Git Account Values
- Step 5: Download the CS Unplugged Repository
- Step 6: Install Docker
- Step 7: Install Text Editor/IDE (optional)
- Step 8: Install Developer Tools (optional)
- Step 9: Check Project Setup Works
- Project Structure
- Helper Commands for Developing
build
clean
collect_static
compilemessages
docs
end
flush
help
logs
makemessages
makemigrations
makeresources
makeresourcethumbnails
migrate
reboot_django
rebuild_index
restart
shell
start
static
static_prod
static_scratch
style
test_backwards
test_coverage
test_specific
test_suite
update
updatedata
update_lite
wipe
- Author Documentation
- Writing Guide
- Blockquotes
- Boxed Text (Verto feature)
- Code
- Comment (Verto feature)
- Conditional (Verto feature)
- Embed iframe (Verto feature)
- Emphasis
- Glossary Link (Verto feature)
- Heading (Verto feature)
- Image (Verto feature)
- Interactive (Verto feature)
- Line Breaks
- Links
- Lists
- Math
- Panel (Verto feature)
- Scratch (Verto feature)
- Table of Contents (Verto feature)
- Tables
- Video (Verto feature)
- Writing Philosophy
- Understanding Configuration Files
- Topic Content
- Topics Overview
- Topics Content Directory
- Content Files
- Adding Content
- Adding a Topic
- Adding a Unit Plan
- Adding a Lesson
- Adding Learning Outcomes
- Adding Curriculum Areas
- Adding a Programming Challenge
- Adding a Curriculum Integration
- Adding Glossary Definitions
- Adding a Classroom Resource
- Adding an Age Group
- Adding a Programming Challenge Difficulty
- Adding Programming Challenge Languages
- Configuration Files
- Application Structure Configuration File
- Topic Configuration File
- Unit Plan Configuration File
- Lesson Configuration File
- Age Group Configuration File
- Learning Outcomes Configuration File
- Curriculum Areas Configuration File
- Programming Challenges Structure Configuration File
- Programming Challenges Configuration File
- Curriculum Integrations Configuration File
- Classroom Resources Configuration File
- Content Style Guide
- Translations
- Writing Guide
- Developer Documentation
- Other Documentation
- Troubleshooting
- Changelog