Welcome to Kitsune’s documentation!

Part 1: Contributor’s Guide

• Join this project!
  • Help with support!
  • Help with hacking!
  • Help with making Kitsune easier for hacking on!
• Hacking HOWTO for Contributors
  • Summary
  • Operating systems
  • Requirements
  • Getting the Source
  • Setting up an Environment
  • Installing dependencies
  • Configuration and Setup
  • Testing it out
  • Trouble-shooting
  • Advanced install
• Contact us
  • SUMO contributor forums
  • Kitsune hackers

Part 2: Developer’s Guide

• Conventions
  • Coding conventions
  • Git conventions
• Patching Kitsune
  • The Quick and Dirty
  • The Details
• Development
  • Changes that involve new Python dependencies
  • Changes that involve database migrations
  • Creating a data migration
  • Changes that involve reindexing
• All about testing
  • Running the Test Suite
  • Writing New Tests
  • Changing Tests
  • Removing Tests
  • JavaScript Tests
  • Functional UI Tests
• Celery and Rabbit
  • When is Celery Appropriate
  • RabbitMQ
  • Celery
• Redis
  • Installation
  • Configuration
  • Running redis
• Running Kitsune with mod_wsgi
  • Requirements
  • Overview
  • File Permissions
  • Debugging
  • Reloading WSGI
• Email from Kitsune
  • Sending Email
• Localization
  • Making Strings Localizable
  • Testing localized strings
  • Linting localized strings
  • Getting the Localizations
  • Updating the Localizations
  • Compiling MO Files
  • Reporting errors in .po files
• Search
  • Installing Elasticsearch
  • Using Elasticsearch
  • Searching on the site
• Frontend Infrastructure
  • Bundles
  • Style Sheets
  • Javascript
  • Bower
• Army of Awesome
  • Setting up the Army of Awesome Twitter Application
  • Fetch tweets
  • Common replies
• Karma System
• Important Wiki Documents
• Other Notes
  • Questions
• Licenses

Part 3: SUMO

• API
  • Search suggest API
  • Locales API
• IRC Bots
  • firebot
  • travis-ci
  • kitsunebot
  • qatestbot
• Kitsune Deployments
  • The Source
  • Branches
  • Dev
  • Stage
  • Production
• Standard Operating Procedure
  • Site is broken because of bad locale msgstr
• Service Level Agreement

Part 4: Administration

• Products and Topics
  • Adding Products
  • Adding Topics
• Groups
  • Group Types
  • Adding Groups
  • Managing Permissions
• Users
  • User Roles
  • Managing Permissions
  • Removing Users
• Questions
  • Configuring new products
  • Question States
• Forums
  • Forum Types
  • Adding Forums
  • Managing Permissions
• Badges
  • Creating a New Badge
  • Badge Image Requirements
  • Awarding Badges Manually
  • Automatic Badges

Indices and tables

• Index
• Module Index