OpenHatch
latest
  • Contributor’s Guide
  • Technical Guide to Development and Documentation
    • Documentation Style Guide
    • Layout of OpenHatch’s source code
    • Advanced installation
    • Working with git
    • Advanced testing
    • Deployment
    • Deploying to Heroku
    • Maintenance tasks
    • Adding a new bug tracker via git
    • Developer Notes
  • Operations Guide
  • Tutorials
  • Community Guide

Contributor's Guide

  • Project Overview
  • Key Features of openhatch.org
  • Getting Started
  • Installation
  • Testing Basics
  • Documentation Basics
  • How we handle contributions

Technical Guide

  • Documentation Style Guide
  • Layout of OpenHatch’s source code
  • Advanced installation
  • Working with git
  • Advanced testing
  • Deployment
  • Deploying to Heroku
  • Maintenance tasks
  • Adding a new bug tracker via git
  • Developer Notes

Operations Guide

  • Monitoring
  • Continuous Integration
  • Backups of the live site
  • Emergency operations for the OpenHatch server
  • WordPress theming
  • Front-end style guide
  • Web API
  • Checking Coding Style Errors in Pull Requests with lint-review
  • Issue tracking using GitHub Issues

Tutorials

  • Writing Training Missions
  • Adding a new bug tracker

Community Guide

  • About the OpenHatch community
  • Contact Us
  • Login Team
  • Login Team Agreement
  • Web Analytics Team
  • Domain Team
  • Collaboration tools
  • Quotes database
  • Ticket tracking
  • How to run an OpenHatch sprint
  • THANKS
OpenHatch
  • Docs »
  • Technical Guide to Development and Documentation
  • Edit on GitHub

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
Next Previous

© Copyright 2012-2015, OpenHatch contributors. Permission to re-use granted under the terms of CC Zero 1.0. Revision ce29352a.

Built with Sphinx using a theme provided by Read the Docs.