Welcome to the CS Field Guide¶
Welcome to the documentation for the CS Field Guide 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
Author Documentation¶
This documentation is for those who want to help write content for the CS Field Guide project, specifically text content. This is the documentation to read if you want to do any of the following (or similar):
- Add a new chapter or chapter section
- Add a translation
Developer Documentation¶
This documentation is for those who want to contribute to developing the Django system for delivering the CS Field Guide 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
- Edit the static files (images, CSS, JavaScript, etc) used within the website
- Add an interactive to the website
- Contribute to the 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: Set up Virtual Machine (optional)
- Step 2: Install Git
- Step 3: Create GitHub Account
- Step 4: Set Git Account Values
- Step 5: Download the CS Field Guide Repository
- Step 6: Install Docker
- Step 7: Install Text Editor/IDE (optional)
- Step 8: Install Developer Tools (optional)
- Step 9: Check Project Setup Works
- Uninstallation
- Project Structure
- Helper Commands for Developing
build
clean
collect_static
_compilemessages
docs
end
help
logs
make_interactive_thumbnails
makemessages
makemigrations
migrate
reboot_django
rebuild_index
restart
restart_build
shell
start
static
static_prod
style
test_backwards
test_coverage
test_specific
test_suite
update
update_static
updatedata
wipe
- Author Documentation
- Writing Guide
- Blockquotes
- Boxed Text (Verto feature)
- Code
- Comment (Verto feature)
- Conditional (Verto feature)
- Embedded 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 structure
- Understanding Configuration Files
- Chapters
- Curriculum Guides
- Content Style Guide
- Translations
- Writing Guide
- Developer Documentation
- Other Documentation
- Troubleshooting
- Changelog