Welcome to Bedrock’s documentation!

bedrock is the project behind www.mozilla.org. It is as shiny, awesome, and open-source as always. Perhaps even a little more.

bedrock is a web application based on Django, a Python web application framework.

Patches are welcome! Feel free to fork and contribute to this project on Github.

Contents

• Installing Bedrock
  • Installation Methods
  • Run the tests
  • Make it run
  • Localization
  • Feature Flipping (aka Switches)
• Localization
  • Fluent
  • All
• Developing on Bedrock
  • Managing Dependencies
  • Asset Management and Bundling
  • Writing JavaScript
  • Writing URL Patterns
  • Finding Templates by URL
  • Optimizing Images
  • Embedding Images
  • Using Large Assets
  • Writing Migrations
  • Writing Views
  • Coding Style
  • Test coverage
  • Configuring your Code Editor
  • Working with Protocol Design System
• How to contribute
  • Git workflow
  • Git commit messages
  • Submitting your work
  • Squashing your commits
  • Server architecture
  • Pushing to production
• Continuous Integration & Deployment
  • Tests in the lifecycle of a change
• Front-end testing
  • Installation
  • Running Jasmine tests using Karma
  • Running functional tests
  • Writing Selenium tests
  • Debugging Selenium
  • Guidelines for writing functional tests
  • Testing Basket email forms
  • Headless tests
• Managing Redirects
  • Add a redirect
  • Differences
  • Utilities
  • Testing redirects
• Newsletters
  • Features
  • Newsletters
  • Bedrock and Basket
  • URLs
  • Configuration
  • Footer signup
• Contentful CMS Integration
  • Overview
  • Content Models
  • Adding support for a new product icon, size, folder
  • Rich Text Rendering
  • L10N
  • Assets
  • Preview
  • Roles/Permissions
  • Development practices
  • Useful Contentful Docs
  • Assumptions we still need to deal with
• Sitemaps
  • Quick summary
• Using External Content Cards Data
  • Add to a View
  • Add to the Template
• Banners
  • Creating page banners
  • Fundraising banner
• Mozilla.UITour
  • Introduction
  • Local development
  • JavaScript API
• Send to Device Widget
  • Usage
• Firefox Download Buttons
  • Which button should I use?
  • Documentation
  • External referrers
• Firefox Accounts Referrals
  • Firefox Account Signup Form
  • Firefox Account Links
  • Firefox Monitor Links
  • Pocket Links
  • Common FxA Parameters
  • Mozilla VPN Links
  • Link Metrics
  • Tracking External Referrers
  • URL Parameter Conventions
  • Firefox Sync and UITour
  • Testing Signup Flows
  • Google Analytics Guidelines
• Funnel cakes and Partner Builds
  • Funnel cakes
  • Partner builds
• A/B Testing
  • Convert experiments
  • Traffic Cop experiments
  • Avoiding experiment collisions
• Analytics
  • Google Tag Manager (GTM)
  • The GTM DataLayer
  • DataLayer Push Example
  • The Core DataLayer Object
  • GTM Listeners & Data Attributes
  • Some notes on how this looks in GA
  • Glean
• Firefox Stub Attribution
  • How does it work in bedrock?
  • Local testing
  • Measuring campaigns and experiments
  • Return to addons.mozilla.org (RTAMO)
• Mozilla VPN Affiliate Attribution
• Architectural Decision Records
  • 1. Record architecture decisions
  • 2. Move CI/CD Pipelines to Gitlab
  • 3. Use Cloudflare Workers and Convert for multi-variant testing
  • 4. Use Fluent For Localization
  • 5. Use a Single Docker Image For All Deployments
  • 6. Revise tooling for Python dependency management
  • 7. Further revise tooling for Python dependency management
• Browser Support
  • Browser Support Matrix (Updated 2022-07-06)
  • Delivering basic support
  • Delivering degraded support
  • Exceptions (Updated 2019-06-11)