Kuma

Kuma is the platform that powers MDN (developer.mozilla.org)

Development

Code:

https://github.com/mdn/kuma

Issues:

P1 Bugs (to be fixed in current or next sprint)

P2 Bugs (to be fixed in 180 days)

All developer.mozilla.org bugs

Pull Request Queues

Dev Docs:

https://kuma.readthedocs.io/en/latest/installation.html

CI Server:

https://travis-ci.org/mdn/kuma

Forum:

https://discourse.mozilla.org/c/mdn

IRC:

irc://irc.mozilla.org/mdndev

Servers:

What’s Deployed on MDN?

https://developer.allizom.org/ (stage)

https://developer.mozilla.org/ (prod)

Getting started

Want to help make MDN great? Our contribution guide lists some good first projects and offers direction on submitting code.

Contents:

• Installation
  • Docker setup
  • Load the sample database
  • Compile locales
  • Generate static assets
  • Visit the homepage
  • Create an admin user
  • Update the Sites section
  • Enable GitHub/Google authentication (optional)
  • Interact with the Docker containers
• Development
  • Basic Docker usage
  • Running Kuma
  • Running the tests
  • Front-end development
  • Database migrations
  • Coding conventions
  • Managing dependencies
  • Customizing with environment variables
  • Customizing number of workers
  • Customizing the Docker environment
  • Customizing the database
  • Generating production assets
  • Using secure cookies
  • Maintenance mode
  • Serving over SSL / HTTPS
  • Enabling PYTHONWARNINGS
  • Configuring AWS S3
  • Enabling django-querycount
• Troubleshooting
  • Kuma “Reset”
  • Reset a corrupt database
  • Run alternate services
  • Linux file permissions
  • KumaScript macros are not evaluating
  • Fixing a 404 error on a specific page
  • Getting more help
• The Kuma test suite
  • Setup
  • Running the test suite
  • Markers
  • Adding tests
  • Changing tests
  • Removing tests
• Client-side testing
  • Setting up test environment
  • Running the tests
  • Using Alternate Environments
  • MDN CI Infrastructure
  • Markers
  • Guidelines for writing tests
• Feature toggles
  • Waffle features
  • Constance features
  • Using Traffic Cop for A/B Testing
• Celery and async tasks
  • When is Celery appropriate
  • Celery services
  • Configuring and running Celery
• Search
  • Installed version
  • Indexing documents
  • Search Filters
• Localization
  • Build the localizations
  • Update the localizations in Kuma
  • Update the localizable strings in Pontoon
  • Add a new locale to Pontoon
  • Enable a new locale on MDN
• CKEditor
  • Building CKEditor
  • Updating CKEditor
  • Updating CKEditor plugins
  • Interactively developing CKEditor plugins
  • Committing Changes
• Getting Data
  • The Sample Database
  • Add an MDN User
  • Add an MDN Wiki Document
  • Add Documents Linked from a Page
  • Create the Sample Database
  • Load Custom Data
  • Anonymized Production Data
• Documentation
  • Generating documentation
• Docker
  • Docker Images
• Deploying MDN
  • Pre-Deployment
  • Deploy to Staging
  • Deploy to Production
  • Deploy to Standby Environment
• Rendering Documents
  • Revision content
  • Bleached content
  • KumaScript content
  • Rendered content
  • Body HTML
  • Quick links HTML
  • ToC HTML
  • Summary text and HTML
  • Diff format
  • Triaged content
  • Preview content
  • Raw content
  • Live sample
  • Search content
  • Future Changes
  • History
• Building, collecting, and serving assets
  • Extracting and building locale files
  • Building localization JavaScript
  • Building CKEditor
  • Including JS libraries
  • Building pipeline JavaScript bundles
  • Building pipeline CSS bundles
  • Collecting asset files with staticfiles
  • django-pipeline
  • Template tag static
  • Template tag statici18n
  • Template tags javascript and stylesheet
  • Serving assets with WhiteNoise
  • Future
  • History