Welcome to Kitsune’s documentation!

Part 1: Contributor’s Guide

• Join this project!
  • Help with support!
  • Help reporting bugs
  • Help with hacking!
  • Help with making Kitsune easier for hacking on!
• Development Setup
  • Summary
  • Getting up and running
  • Admin interface
  • Get search working
  • Further setup
  • Running the tests
• 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
  • When is Celery Appropriate
  • Configuring and Running
• Running Kitsune with mod_wsgi
  • Requirements
  • Overview
  • File Permissions
  • Debugging
  • Reloading WSGI
• Email from Kitsune
  • Viewing email through Mailcatcher
  • Actually sending email
• Localization
  • Making Strings Localizable
  • Testing localized strings
  • Linting localized strings
  • Getting the Localizations
  • Updating the Localizations
  • Compiling MO Files
  • Why aren’t localized strings getting updated on prod?
• Search
  • Installing Elasticsearch
  • Using Elasticsearch
  • Searching on the site
• Frontend Infrastructure
  • Bundles
  • Style Sheets
  • Javascript
  • NPM
• Other Notes
  • Questions

Part 3: SUMO

• API
  • Search suggest API
  • Locales API
• Kitsune Deployments
  • The Source
  • Branches
  • Deploying
  • Servers
  • Development
  • Staging
  • Production
• SUMO Kubernetes Support Guide
  • Links
  • K8s commands
  • Monitoring
  • Operations
• Service Level Agreement
• Architectural Decision Records
  • 1. Record architecture decisions

Part 4: Administration

• Users
  • Firefox Accounts
• Ask A Question
  • Configuring new products
  • Question States
• Badges
  • KB Badge & L10n Badge
  • Support Forum Badge
  • Army of Awesome Badge