Technical Guide to Development and Documentation

If you’ve made it this far without saying hello you should definitely do so!

• Documentation Style Guide
• Layout of OpenHatch’s source code
  • Directory structure
  • Informational Files
  • dotfiles
  • Other files and executable files
• Advanced installation
  • Overriding local settings
  • Automated testing
  • Optional dependencies
  • Maintenance
• Working with git
  • Issues with Pull Requests
  • Become a git Expert
• Advanced testing
  • Tests: An overview
  • General testing tips
  • Details specific to OpenHatch
  • About fixtures
  • Mocking and patching
  • Testing with Twill, versus the Django test client
• Deployment
  • Prerequisites
  • How the deploy script works
  • Recommended way to use the deploy script
  • Notes about the deployment
  • Other sites we host
• Deploying to Heroku
  • Overview
  • Install the Heroku toolbelt and log in
  • Create a Heroku app
  • Set up the database
  • Visit your app on the web
  • Troubleshooting
• Maintenance tasks
  • Importing data snapshots
  • How to run the bug importer
  • Run the hourly tasks related to profiles
  • Adding jQuery UI components
  • Editing the website’s CSS
• Adding a new bug tracker via git
  • Clone the repository
  • Overview of steps
  • In a little more detail
  • Submit a patch
• Developer Notes
  • January 2015 Notes