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
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
- Project Structure
- Helper Commands for Developing
- 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
- 3.10.0
- 3.9.0
- 3.8.5
- 3.8.4
- 3.8.3
- 3.8.2
- 3.8.1
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.1
- 3.5.0
- 3.4.0
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.12.2
- 2.12.1
- 2.12.0
- 2.11.0
- 2.10.1
- 2.10.0
- 2.9.1
- 2.9.0
- 2.8.1
- 2.8.0
- 2.7.1
- 2.7.0
- 2.6.1
- 2.6.0
- 2.5.0
- 2.4.1
- 2.4
- 2.3
- 2.2
- 2.1
- 2.0
- 2.0-alpha.3
- 2.0-alpha.2
- 2.0-alpha.1
- 1.?.?