Permalink
Fetching contributors…
Cannot retrieve contributors at this time
141 lines (105 sloc) 3.56 KB

Welcome to OpenHatch's Documentation

OpenHatch values open communication. We believe documentation is an important part of a welcoming community. If you would like to see some of the projects that we are currently working on, please visit the OpenHatch website <http://openhatch.org>.

Trying to get your bearings with our documentation? Take a look at the :doc:`getting_started/project_overview` or :doc:`community/contact` to ask questions. We also have a wiki with a lot of informal documentation and other useful things on it.

Confused or dismayed by our documentation? Please let us know so we can improve it! Make an issue on our issue tracker or :doc:`community/contact` via email or IRC to chat with us about it. We take our documentation seriously and wish it to be helpful to you.

Contents

.. toctree::
    :maxdepth: 1

    getting_started/index
    advanced/index
    internals/index
    tutorials/index
    community/index


Contributor's Guide

The Contributor's Guide provides an introduction to contributing to the OpenHatch project.

.. toctree::
   :maxdepth: 1
   :caption: Contributor's Guide

   getting_started/project_overview
   getting_started/key_features_openhatch_site
   getting_started/getting_started
   getting_started/installation
   getting_started/testing_basics
   getting_started/documentation
   getting_started/handling_contributions


Technical Guide to Development and Documentation

The Technical Guide provides information to contributors interested in developing software or writing documentation for OpenHatch projects.

.. toctree::
   :maxdepth: 1
   :caption: Technical Guide

   advanced/styleguide
   advanced/layout_source_code
   advanced/advanced_installation
   advanced/working_with_git
   advanced/advanced_testing
   advanced/deployment
   advanced/heroku
   advanced/maintenance
   advanced/adding_new_bug_tracker_git
   advanced/developer_notes


Operations Guide

The Operations Guide gives an overview of the infrastructure and processes that keep the OpenHatch website running efficiently.

.. toctree::
   :maxdepth: 1
   :caption: Operations Guide

   internals/monitoring
   internals/continuous_integration
   internals/backup
   internals/emergency_operations
   internals/wordpress
   internals/front_end_style_guide
   internals/api
   internals/pull_request_linting
   internals/issue_tracking


Tutorials

We encourage our contributors to write tutorials and share their process knowledge with other contributors. The tutorials are intended to be focused 'how to' documents.

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/writing_missions
   tutorials/adding_new_bug_tracker_web


Community Guide

Many people help OpenHatch serve newcomers to open source. The Community Guide helps explain our teams, individuals, and activities that support our goal of being a welcoming and helpful community.

.. toctree::
   :maxdepth: 1
   :caption: Community Guide

   community/about_our_community
   community/contact
   community/login_team
   community/login_team_agreement
   community/web_analytics_team
   community/domain_team
   community/collaboration_tools
   community/quotes_db
   community/ticket_tracking
   community/sprints
   community/thanks


Indices and tables